Requirements

To run this app, you will need the following software:

Installation

  • Check that you have python
    python --version

  • Check that you have Django
    django-admin --version

  1. Clone our repository into your machine

  2. Create env.sh shell script and fill it with your credentials and run the shell script
    export EMAIL=""
    export PASSWORD=""
    export SECRET_KEY="[can't be empty]"
    export DB_HOST="0.0.0.0"
    export DB_NAME="test_db"
    export DB_USER="root"
    export DB_PASSWORD="root"

  3. In your terminal, run docker compose
    docker compose up -d

  4. Go into college_living folder

  5. Install requirements packages
    pip install -r requirements.txt

  6. Migrate model into database
    python manage.py migrate

  7. Load initial data
    python manage.py loadata colleges/fixtures/*.json

  8. Start server
    python manage.py runserver

  9. Go to http://127.0.0.1:8000/ and start exploring!