README add node instructions and our deployment instructions

This commit is contained in:
Dan Ballard 2022-05-24 17:32:03 -07:00
parent 9e6df7b0e4
commit eaaa76893c
2 changed files with 26 additions and 10 deletions

View File

@ -8,12 +8,29 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
$ yarn
```
or
install [NVM](https://github.com/nvm-sh/nvm) to manage multiple and new NodeJS versions, and then install NodeJS 16
```
$ nvm install 16
$ nvm use 16
```
*nvm only works in bash shell*
### Local Development
```
$ yarn start
```
or
```
$ npm run start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
@ -22,20 +39,19 @@ This command starts a local development server and opens up a browser window. Mo
$ yarn build
```
or
```
$ npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
Using git.openprivacy.ca to manage but deployment by push is to a seperate docs server. Add your key to the docusaurus account's .ssh/authorized_keys and then
```
$ USE_SSH=true yarn deploy
$ git remote add docs docusaurus@docs.cwtch.im:/home/docusaurus/git/docs.cwtch.im
$ git push docs main
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.5 KiB