Skip to content

README.md

Latest commit

 

History

History
35 lines (31 loc) · 1.36 KB

README.md

File metadata and controls

35 lines (31 loc) · 1.36 KB
Raw

Before development - Local

  1. Create a project folder.
  2. Go inside the project folder.
  3. Cloning the repo git clone --recursive https://github.com/SUTD-3DC/3DC_web_py.git.
  • Below are based on unix command
  1. Install virtual environment by running sudo pip3 install virtualenv.
  2. Create virtual environment with virtualenv -p python3 venv.
  3. Start virtual environment with source venv/bin/activate
  4. Install required library.
  • cd 3DC_web_py
  • pip3 install -r requirement.txt

Frontend

  1. cd project_folder/3DC_web_py/app/frontend.
  2. Run npm run dev.
  3. Access the webpage using any browser with http://localhost:8080.

Backend

  1. SSH to server.
  2. Go to 3DC_web_py/app/frontend.
  3. Run npm run dev.
  4. Open new terminal tab and SSH to server.
  5. Go to 3DC_web_py.
  • Run konch for testing small chunk of backend code.
  1. Configure flask app by export FLASK_APP=app.
  2. Configure the flask environment by export FLASK_ENV=development.
  3. Start flask app with flask run -h 0.0.0.0 -p port; available port=[5000, 50001, 5002]
  4. Access the webpage using any browser with http://server-ip:port.

Development

  1. Frontend and Backend must commit on the same branch for the same feature.

Prerequisite Software

  1. Gitkraken - GUI tool for git version control.
  2. Filezilla - File transfer tools between server and local directory.