- Create a project folder.
- Go inside the project folder.
- Cloning the repo
git clone --recursive https://github.com/SUTD-3DC/3DC_web_py.git
.
- Below are based on unix command
- Install virtual environment by running
sudo pip3 install virtualenv
. - Create virtual environment with
virtualenv -p python3 venv
. - Start virtual environment with
source venv/bin/activate
- Install required library.
cd 3DC_web_py
pip3 install -r requirement.txt
- cd
project_folder/3DC_web_py/app/frontend
. - Run
npm run dev
. - Access the webpage using any browser with
http://localhost:8080
.
- SSH to server.
- Go to
3DC_web_py/app/frontend
. - Run
npm run dev
. - Open new terminal tab and SSH to server.
- Go to
3DC_web_py
.
- Run
konch
for testing small chunk of backend code.
- Configure flask app by
export FLASK_APP=app
. - Configure the flask environment by
export FLASK_ENV=development
. - Start flask app with
flask run -h 0.0.0.0 -p port
; available port=[5000, 50001, 5002] - Access the webpage using any browser with
http://server-ip:port
.
- Frontend and Backend must commit on the same branch for the same feature.
- Gitkraken - GUI tool for git version control.
- Filezilla - File transfer tools between server and local directory.