mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-09 13:51:57 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(docs): Adjust getting started docs

Browse source 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2022-12-05 20:16:27 +01:00
parent 298b6bc205
commit 60db7f4931
4 changed files with 36 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,8 +1,40 @@
# Getting started
This document will help you with setting up the development environment for HedgeDoc 2.
## Preparation
Setup the [backend](./setup/backend.md) and the [frontend](./setup/frontend.md).
### Preparing the directory
1. Make sure that NodeJS is installed. You need at least Node 14 (we recommend Node 18).
2. Make sure that [yarn](https://yarnpkg.com/) is installed.
3. Clone this repo (e.g. `git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc`)
4. Go into the cloned directory
### Installing the dependencies
Because we use yarn workspaces, yarn collects the dependencies of all packages automatically in one central top-level node_modules folder.
To install the dependencies execute `yarn install` at the top level of the cloned repository.
Execute this command ONLY there. There is no need to execute the install-command for every package.
It's important to use [yarn](https://yarnpkg.com/). We don't support npm or any other package manager and using anything else than yarn won't work.
### Compile the commons package
Some code is shared by backend and frontend. This code lives in the "common" package and needs to be compiled so frontend and backend can import it.
This only needs to be done once, except if you've changed code in the commons package.
1. Go into the `commons` directory.
2. Execute `yarn build` to build the commons package.
## Setting up the backend
1. Go into the `backend` directory.
2. Create an environment file. We recommend to use the example file by running `cp .env.example .env`
You can modify this file according to the [configuration documentation](../config/index.md).
3. Make sure that you've set `HD_SESSION_SECRET` in your `.env` file. Otherwise, the backend won't start.
> In dev mode you don't need a secure secret. So use any value. If you want to generate a secure session secret you can generate one using e.g. `openssl rand -hex 16 | sed -E 's/(.*)/HD_SESSION_SECRET=\1/' >> .env`.
## Setting up the frontend
The instructions for the frontend can be found [here](./setup/frontend.md).
## Running backend and frontend together