Student Help and Moral Encouragement (SHaME) is an Android application designed to help students and faculty collate deadlines on one platform, making it easier to track.
Faculty are able to see the number of students enrolled that have completed each of their set deadlines, allowing them to extend the deadline if they feel not enough students have completed it.
Students are able to see a chronologically sorted list of deadlines set by the modules they have subscribed to, and can mark deadlines as completed, enabling them to better prioritize their time and workload.
The Android project can be found in the Infosys1D folder in this repo, and can be built as-is.
How to run:
-
Via provided virtual environment:
- All required dependencies have been added in the included virtual environment
- Run
.\venv\Scripts\activateon Windows to activate the virtual environment - Run
source myvenv/bin/activateon *nix OSes to activate the virtual environment - Start the backend from within the virtual environment with
uvicorn backend:app
-
From your own Python installation:
- pip install the provided requirements.txt file to install all required dependencies
- Start the backend with 'uvicorn backend:app'
The backend should now be listening on localhost port 8000
localhost:8000/docs can be accessed to see a list of available endpoints for use from the API
To run on servers other than localhost, two values have to be updated:
- In the Android project, update
API_AUTHORITYinres/values/strings.xmlto the new desired endpoint. - When starting the
uvicornapplication, specify the--host(and--port, if necessary), e.g.:
uvicorn --host newaddress.com --port 422 backend:app
The backend and application should now be running on the new specified host / port.
Team 1B
- Alex Lee 1005195
- Bryan Sitoh 1005040
- Emmanuel J.Lopez 1005407
- Ernest Lim 1005234
- Gao Fancheng 1004879
- Lyu Haozhi 1004888
- Yu Qin 1005327