LailaTheElf/hedgedoc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #208 from jfowl/doc-change-to-yarn

Browse Source 
Replace `npm` with `yarn` commands in docs.
This commit is contained in:
Sheogorath 2019-10-28 01:12:17 +01:00 committed by GitHub
commit d19c8102a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/dev/getting-started.md
View File

@ -18,7 +18,7 @@ Developer Notes
Now that everything is in place, we can start CodiMD: Now that everything is in place, we can start CodiMD:
4. `npm run build` will build the frontend bundle. It uses webpack to do that. 4. `yarn run build` will build the frontend bundle. It uses webpack to do that.
5. Run the server with `node app.js` 5. Run the server with `node app.js`
@ -32,7 +32,7 @@ rebuild the frontend or restart the server if necessary.
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.
4. Use `npm run dev` if you want webpack to continuously rebuild the frontend 4. Use `yarn run dev` if you want webpack to continuously rebuild the frontend
code. code.
5. To auto-reload the server, the easiest method is to install [nodemon](https://www.npmjs.com/package/nodemon) 5. To auto-reload the server, the easiest method is to install [nodemon](https://www.npmjs.com/package/nodemon)
and run `nodemon --watch app.js --watch lib --watch locales app.js`. and run `nodemon --watch app.js --watch lib --watch locales app.js`.

8
docs/setup/manual-setup.md
View File

@ -18,10 +18,10 @@ Manual Installation
3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs. 3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs.
4. Setup the configs, see more below 4. Setup the configs, see more below
5. Setup environment variables which will overwrite the configs 5. Setup environment variables which will overwrite the configs
6. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development) 6. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development)
7. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string 7. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string
For example: `postgres://username:password@localhost:5432/codimd` For example: `postgres://username:password@localhost:5432/codimd`
8. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development). 8. It is recommended to start your server manually once: `yarn start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
9. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts) 9. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
@ -34,6 +34,6 @@ If you are upgrading CodiMD from an older version, follow these steps:
3. Fully stop your old CodiMD server. 3. Fully stop your old CodiMD server.
4. `git pull` or unzip a new release in the directory. 4. `git pull` or unzip a new release in the directory.
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. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development). 6. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development).
7. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development). 7. It is recommended to start your server manually once: `yarn start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
8. You can now restart the CodiMD server! 8. You can now restart the CodiMD server!