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

Docs: Add mention to install devDependencies

Browse source 
Before `yarn build` can be succesfully run, we need to install the devDependencies.
This is necessary, because `bin/setup` does not install the devDependencies…

Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2021-05-08 10:08:21 +02:00
parent 3e836d815b
commit a4b4ebd80c
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
bin/setup
View file

@ -50,7 +50,7 @@ echo "Installing packages..."
yarn install --production=true --pure-lockfile yarn install --production=true --pure-lockfile
cat << EOF cat << EOF
If you want to build the frontend yourself, you need to run 'yarn install' before 'yarn build' to install the devDependencies for the build process.
Edit the following config file to setup HedgeDoc server and client. Edit the following config file to setup HedgeDoc server and client.
Read more info at https://docs.hedgedoc.org/configuration/ Read more info at https://docs.hedgedoc.org/configuration/

4
docs/content/setup/manual-setup.md
View file

@ -34,7 +34,7 @@
It's also possible to use environment variables. It's also possible to use environment variables.
For details, have a look at [the configuration documentation](../configuration.md). For details, have a look at [the configuration documentation](../configuration.md).
5. *:octicons-light-bulb-16: If you use the release tarball for 1.7.0 or newer, this step can be skipped.* 5. *:octicons-light-bulb-16: If you use the release tarball for 1.7.0 or newer, this step can be skipped.*
Build the frontend bundle by running `yarn run build`. Build the frontend bundle by running `yarn install` and then `yarn build`. The extra `yarn install` is necessary as `bin/setup` does not install the build dependencies.
6. It is recommended to start your server manually once: 6. It is recommended to start your server manually once:
```shell ```shell
NODE_ENV=production yarn start NODE_ENV=production yarn start
@ -61,7 +61,7 @@ If you want to upgrade HedgeDoc from an older version, follow these steps:
<small>If you use Git, you can check out the new tag with e.g. `git fetch origin && git checkout 1.8.1`</small> <small>If you use Git, you can check out the new tag with e.g. `git fetch origin && git checkout 1.8.1`</small>
5. Run `bin/setup`. This will take care of installing dependencies. It is safe to run on an existing installation. 5. Run `bin/setup`. This will take care of installing dependencies. It is safe to run on an existing installation.
6. *:octicons-light-bulb-16: If you used the release tarball for 1.7.0 or newer, this step can be skipped.* 6. *:octicons-light-bulb-16: If you used the release tarball for 1.7.0 or newer, this step can be skipped.*
Build the frontend bundle by running `yarn run build`. Build the frontend bundle by running `yarn install` and `yarn build`. The extra `yarn install` is necessary as `bin/setup` does not install the build dependencies.
7. It is recommended to start your server manually once: 7. It is recommended to start your server manually once:
```shell ```shell
NODE_ENV=production yarn start NODE_ENV=production yarn start