github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 11:16:31 -05:00
Code Issues Projects Releases Packages Wiki Activity

Apply suggestions from code review

Browse source 
Use real backend by default.
Start server with NODE_ENV set to development mode.

Co-authored-by: David Mehren <git@herrmehren.de>
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
This commit is contained in:
Chasethechicken 2021-12-15 22:22:11 +01:00 committed by David Mehren
parent 30ab3e3831
commit ec4d539c99
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 4 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/content/dev/getting-started.md
View file

@ -16,7 +16,7 @@
4. Run `openssl rand -hex 16 | sed -E 's/(.*)/HD_SESSION_SECRET=\1/' >> .env` to generate a session secret if you have not set one manually before. 4. Run `openssl rand -hex 16 | sed -E 's/(.*)/HD_SESSION_SECRET=\1/' >> .env` to generate a session secret if you have not set one manually before.
## Preparing for running the frontend code ## Preparing for running the frontend code
**ToDo:** Document how to setup development environment using docker. **ToDo:** Document how to setup development environment using docker.
@ -32,14 +32,11 @@ We will run Hedgedoc in development mode, which means the backend and frontend w
The commands will stay active in your terminal, so you will need multiple tabs The commands will stay active in your terminal, so you will need multiple tabs
to run both at the same time. to run both at the same time.
1. Enter the `react-frontend` directory and use `yarn start` if you want webpack to continuously rebuild the frontend 1. Enter the `react-frontend` directory and use `yarn start:for-real-backend` if you want webpack to continuously rebuild the frontend code. The frontend will expect a running backend at port 3000.
code.
**Note:** Currently, this will not result in the backend and frontend communicating with each other. **Note:** You can run `yarn start` to start a frontend with an integrated, mocked API. This may support more features than the real backend.
**Note:** You can run `yarn start:for-real-backend` to start a frontend, which tries to connect to a local backend. 2. To start the server in auto-reload mode, enter the `hedgedoc` directory and run `env NODE_ENV=development yarn start:dev`.
2. To auto-reload the server, enter the `hedgedoc` directory and run `yarn start:dev`.
## Testing ## Testing