zippy1981/student-course-management-system repository overview

⁠student-course-management-system

Student course catalog example DJango app.

This started as an assignment for a job I was applying for. My python was rusty and I never touched django. I hit some brick walls and decided I didn't want to cut the corners necessary to deliver this applicaiton without properly "fighting" with Django to get it right.

It's still a work in progress at the moment. I intend on demonstrating proper devop techniques e.g:

• database is configurable by environment variables
• logging is configured y environment variables
• CI upon commitment (in progress)

⁠Running in a development environment

You have two options for running this in a development environment. You can use docker-compose to run it in docker containers with with postgres for the database, or you can run it locally with pipenv and use SQLite as the backend server.

The main advantages of running outside of docker are you don't need docker installed, and I haven't figured out how to get step through debugging working from PyCharm or Visual Studio code from inside the container.

⁠Running on bare metal with pipenv with a SQLite back end

1. If you haven't already done so install pipenv⁠.
2. run pipenv install
3. run pipenv shell
4. run python manage.py migrate
5. run python manage.py loaddata initial_data.json
6. run python manage.py runserver 0.0.0.0:8000
7. navigate to http://localhost:8000⁠ in your browser

⁠Notes about docker and pipenv

This project uses pipenv⁠ inside its docker container to manage dependencies insted of manually using virtualenv and pip with requirements.txt. To run a command inside the pipenv virtualenv locally, you must use the command pipenv run command [args]. To run a command inside the already running running docker container, you must use the command docker-compose exec web command [args]. Therefore, to run a command inside the pipenv, inside the already running running docker container, you must use the command docker-compose exec web pipenv run command [args].

If you want to start a new container (e.g. if you don't have the web server running) to run a command just replace docker-compose exec with docker-compose run. Note that this will cause the db container to start up and remain running.

⁠Docker setup

1. run docker-compose run web pipenv run python manage.py migrate
2. run docker-compose up -d or to to keep a tail of the container console messages in a new terminal omit the -d (i.e. docker-compose up)
3. run docker-compose exec web pipenv run python manage.py loaddata initial_data.json
4. run docker-compose exec web pipenv run python manage.py createsuperuser and enter auth information
5. navigate to http://localhost:8000⁠ in your browser

⁠Resetting the envinment

If you want to start with a clean databaase the quickest way is with the following commands:

1. docker-compose rm -fvs db
2. docker-compose up -d db
3. docker-compose exec web pipenv run python manage.py migrate
4. docker-compose exec web pipenv run python manage.py loaddata initial_data.json

⁠Connecting to the database for local devugging, etc

Create a docker-compose.override.yml with the following:

version: '3.4'

services:
  db:
    ports:
      - "5432:5432"
    #environment:
    #  POSTGRES_PASSWO: "stud3ntC0urse"
  adminer:
    image: adminer
    ports:
      - 8080:8080

Then connect to adminer on http://localuost:8080⁠ or with any other sql client directly.

⁠Unit tests

Unit tests can be run with python manage.py test. They are incomplete and I don't have coverage configured correctly.

I have tested several models in test_models.py and the meta data of one of the views in test_views.py.