The College Life is an all-in-one app that you need for your college. We provide course reviews, professor reviews and many more.
For now, we only have the following functionalities:
- Login/Logout
- Course Review
- Professor Review
To run this app, you will need the following softwares:
-
Check that you have python
python --version
-
Check that you have Django
django-admin --version
- Clone our repository into your machine
- Create
env.sh
shell script and fill it with your credentials and run the shell script
export EMAIL=""
export PASSWORD=""
export SECRET_KEY=""
export DB_HOST="0.0.0.0"
export DB_NAME="test_db"
export DB_USER="root"
export DB_PASSWORD="root"
- In your terminal, run docker compose
docker compose up -d
- Go into
college_living
folder - Install requirements packages
pip install -r requirements.txt
- Migrate model into database
python manage.py migrate
- Load initial data
python manage.py loadata colleges/fixtures/*.json
- Start server
python manage.py runserver
- Go to http://127.0.0.1:8000/ and start exploring!
If you want to add a review to the professors, then go to the following url, because we don't have the mapping yet http://127.0.0.1:8000/colleges/university-of-massachusetts-amherst/professors/1/reviews/
The application is separated into separate modularized 'apps'.
This app handles all the user authentication pieces such as login, signup, and more. \
This app handles all-college related things such as colleges, professors, dorms, and more. \