github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-21 17:26:29 -05:00
Code Issues Projects Releases Packages Wiki Activity

fix(docs): correct getting started dev documentation

Browse source 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2022-10-02 21:10:19 +02:00 committed by David Mehren
parent 5dffe35ea1
commit 01d9168819
1 changed files with 2 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -15,33 +15,7 @@
[environment variables](../config/index.md) yourself.
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
**ToDo:** Document how to set up development environment using docker.
## Running backend and frontend together
1. Clone the repository with `git clone https://github.com/hedgedoc/react-client.git`
(cloning is the preferred way, but you can also download and unzip a release)
2. Enter the directory and run `yarn install`.
## Running HedgeDoc with auto-reload
We will run HedgeDoc in development mode, which means the backend and frontend will automatically rebuild or restart when you make changes.
The commands will stay active in your terminal, so you will need multiple tabs
to run both at the same time.
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.
**Note:** You can run `yarn start` to start a frontend with an integrated, mocked API. This may support more features than the real backend.
2. To start the server in auto-reload mode, enter the `hedgedoc` directory and run `env NODE_ENV=development yarn start:dev`.
## Testing
- After starting both frontend and backend, HedgeDoc will be available at `http://localhost:3000`.
**Note:** If you only started the frontend, it will be available at `http://localhost:3001`.
**Note:** If you want to use HedgeDoc with the real backend, point your browser at `http://localhost:3000`, as the backend proxies requests to the frontend and you'll get CORS errors if you try to use the frontend directly.
The documentation for setting up the frontend and how to use it and the backend together can be found in the [frontend repository README](https://github.com/hedgedoc/react-client/blob/main/README.md).