4 Get started

Raccoon edited this page 2017-02-26 17:19:49 +08:00

Table of Contents

• Get started (Run from source code)

Get started (Run from source code)

We support docker deployment and Heroku Deployment.

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
4. Setup 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)

About Project

• Get Started
• Heroku Deployment
• Release Notes
• Server Requirement and Browser suppoort
• Project Structure
• Environment Variables
• Configuration Files and Settings
• Third party integration oauth callback urls
• Roadmap

Migration Tool

• Migration to 0.5.0
• Migration to 0.4.0

Technical Document

• Operational Transformation