mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-09-19 23:48:57 -04:00

rework how the frontend is started (#361 )

renamed frontend-config to api-url
renamed backend-config to config
removed api call to set frontend-config as the frontend either know where the backend is as it is delivered by it or get's this information via the enviroment variable REACT_APP_BACKEND
always start the client on Port 3001 as the backend will run on 3000 during development. changed the port on multiple occasions to accommodate for this
added package.json script 'start:dev'
changed README to better explain how to run backend and frontend side-by-side

2020-07-29 22:58:01 +02:00

1.8 KiB

Raw Blame History

CodiMD - React Client

This is the new, improved and better looking frontend for CodiMD 2.0. Our goal is to recreate the current frontend in react and to improve it.

Preparation

You'll need at least Node 10 (we recommend 12). We use yarn for our dependencies, but npm can work too.

Development mode

Clone this repo (e.g. git clone https://github.com/codimd/react-client.git codimd-react-client)
Go inside the repo (e.g. cd codimd-react-client)
run yarn install
Either run
- yarn start:dev (expects a server running under http://localhost:3000)
- yarn start (makes all api calls to the same domain the react-client runs on (normally http://localhost:3001 ))

This should run the app in the development mode and open http://localhost:3001 in your browser.

The page will reload if you make edits. You will also see any lint errors in the console.

Tests

Unit

Unit testing is done via jest.

run yarn test

End2End

We use cypress for e2e tests.

Run the frontend with yarn start
RUn yarn cy:open to open the cypress test loader
Choose your browser and test
Let the tests run

Production mode

Clone this repo (e.g. git clone https://github.com/codimd/react-client.git codimd-react-client)
Go inside the repo (e.g. cd codimd-react-client)
run yarn install
run yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

1.8 KiB Raw Blame History