Skip to content
This repository has been archived by the owner on Aug 7, 2020. It is now read-only.

Latest commit

 

History

History
42 lines (35 loc) · 1.46 KB

README.md

File metadata and controls

42 lines (35 loc) · 1.46 KB
Raw

hackreg-t1-backend

🤟The backend program for Hackathon 2020 registration website.

Technology Stack

  • PM2
  • Mongodb
  • Express.js
  • TypeScript

Guides

Setting up local development environment

  1. Run these commands to fetch the copy of the project and install the dependent packages using npm. 
    git clone https://github.com/SYSUMSC/hackreg-t1-backend.git
cd hackreg-t1-backend
npm install
  2. Open env/development.env, and refer to the comments to set up mongodb and RSA SHA256 key pair.
  3. Install pm2 globally: npm install pm2 -g.
  4. Run these commands to fire up the development build! Tips: With the help of nodemon, a recompile will automatically be executed whenever there are file changes in src/ and env/. 
    npm run dev

Making a production build and run it

  1. Run npm run build.
  2. Copy the dist/ to wherever you want.
  3. Prepare a new RSA SHA256 key pair and edit env/production.env accordingly.
  4. Run npm install -g pm2 to install pm2 globally.
  5. Run pm2 start app.config.js to fire up the server!

Deployment

  1. Prepare a good mongodb server and a reverse proxy.
  2. Edit env/production.env according to your actual environment.
  3. Follow the guides above.

Documention

Check out the wiki here.

License

This project is licensed under the MIT license, see the LICENSE file for details