This repository holds the REST API for Group 26's ASL Tutor as well as the admin web portal.
- Python 3.7+
- Vagrant
- Virtual Box
- Docker
Install virtual box and vagrant
Make a directory and clone the repo into it
For all methods requests will be directed to http://localhost:1337/
From the terminal cd into the project root (you should see a Vagrantfile) then run the following commands:
vagrant up
vagrant sshFrom the terminal run the following commands:
cd ~/Spring2019-Group26-Backend
chmod +x deploy.sh
./deploy.shThe deploy script will seem like it is hanging, there 40 seconds wait to make sure mongo is started
If you make changes and they do not automatically take effect run:
sudo systemctl restart asltutorFor development you will need to add S3_BUCKET, S3_KEY, and S3_SECRET_ACCESS_KEY to the DevelopmentConfig section of the settings.py file. You will also need to change the DEV flag to True in the main.py file.
From the terminal run the following commands:
sudo apt install enchant
cd ~/Spring2019-Group26-Backend
chmod +x setupenv.sh
./setupenv.shThis sets up the virtual environment, starts mongo and adds the systemd config for asltutor
To start the server you have 3 options:
- with python3: this run using python without uWSGI and outputs logs to the console If you choose this method From the terminal run the following commands:
cd ~/Spring2019-Group26-Backend
chmod +x runpydev.sh
./runpydev.sh- with uWSGI: The first time run the following commands:
cd ~/Spring2019-Group26-Backend
chmod +x runuwsgi.sh
./runuwsgi.shAfter the first time running it using uwsgi control it using systemd
- To stop:
sudo systemctl stop asltutor- To start:
sudo systemctl start asltutor- To restart:
sudo systemctl restart asltutor- To check status run respectively:
sudo systemctl status mongod
sudo systemctl status asltutor- Follow the commands for front end to test deployment and operation
Always test using the deployment script before making a PR
If you are getting an internal server error or you can hit hello world but nothing else the most likely cause is mongo has not been started or was not running before asltutor started
Run the following command to check if mongo is running:
sudo systemctl status mongodIf it is running without errors skip to the part about asltutor
If it is not running run the following command to start it
sudo systemctl start mongodThen wait 30 seconds to a minute and check the status again.
sudo systemctl status mongodIf it is running without errors move on to the part about asltutor
If it is running but has errors you can try running the following commands:
sudo systemctl restart mongodThen wait 30 seconds to a minute and check the status again.
sudo systemctl status mongodIf it still has errors try to google them or rebuild you vagrant machine:
exit
vagrant halt
vagrant destroy -y
vagrant upAfter you have verified that mongo is working correctly now check asltutor Run the following command to check to see if it is running:
sudo systemctl status asltutorIf it is not running run:
sudo systemctl start asltutorIf it is running run:
sudo systemctl restart asltutorIf this does not fix the problem try to google errors and check logs
uWSGI logs are located in
request logs: /tmp/reqlog
error logs: /tmp/errlog
While developing, for changes in the backend code to be reflected in the app you will have to restart the app
sudo systemctl restart asltutor[Not yet enabled] To launch the integration tests, use tox:
sudo pip install tox
toxDocumentation is up for all existing endpoints. Navigate to http://localhost:1337/v1/docs to view the docs. The documentation is interactive so you can use it to send requests if you would like.
To run the server on a Docker container, please execute the following from the root directory:
# building the image
docker build -t app .
# starting up a container
docker run -p 5000:1337 app