Backend API server for InstaDam, an application to create ground truth pixel-wise labels for deep learning based semantic segmentation of complex shapes like mechanical/structural defects in civil infrastructure like buildings and bridges or medical images in a user friendly manner.
Start a development server (Use In-memory Sqlite) :
- Install the dependencies in requirements/dev.txt
pip install -r requirements/dev.txt - The development mode utilize in-memory Sqlite database for fast-prototyping and development,
make sure you have Sqlite installed in your development environment.
Start the server:
python3 manage.py start --mode=development
- Set necessary environment variables for deployment:
- DB_USERNAME: Database username.
- DB_PASSWORD: Database password.
- DB_NAME: Database name for InstaDam app.
- SECRETE_KEY: User supplied secrete key for the app.
- Run
docker-compose upin project root folder
-
First, you should have a PostgreSQL instance up and running on your server.
-
Then you need to set the corresponding environment variables for the InstaDam app:
- _DB_USERNAME: Database username.
- _DB_PASSWORD: Database password.
- _DB_HOSTNAME: Databse hostname
- _DB_NAME: Database name for InstaDam app.
- _SECRETE_KEY: User supplied secrete key for the app.
The default admin username and password is 'admin/AdminPassword0', you can change it ininstadam/config.pybefore deployment.
-
Deploy a production server:
python3 manage.py deploy
The default behavior is to delete all previous data/table structure in the given database and reinitialize from ground up. -
Alternatively, you can reuse the previous data by using
python3 manage.py start --mode=production
Run below command to generate HTML documentation via Pydoc:
sh doc.sh
Nishanth Salinamakki: nishanthrs
Zonglin Li: zli117
Yu Tang: ra1nty
Wanxian Yang: Louise15926