depau/HackMD
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Created Get started (markdown)

Raccoon 2017-02-26 17:16:09 +08:00
parent 41a2cecdbd
commit 78c952b851
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Get-started.md Normal file

@ -0,0 +1,11 @@
Get started (Run from source code)
===
We have the official docker, please refer [docker hackmd](https://github.com/hackmdio/docker-hackmd).
1. Download a release and unzip or clone into a directory
2. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs. The setup script is written in Bash, you would need bash as a prerequisite.
3. Setup the configs, see [Configuration Files and Application Settings](Configuration-Files-and-Application-Settings)
4. Setup [environment variables](Environment-Variables) which will overwrite the configs
5. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development)
6. Run the server as you like (node, forever, pm2)