InnoSport website

The platform for conducting, tracking and checking students' sports activity at Innopolis University.

Requirements:

• Python 3.7
• Docker and Docker Compose

How to start coding

1. Install dependencies: pip3 install -r ./adminpage/requirements.txt
2. Copy environment variables: cp compose/example.env compose/.env
3. Start services: docker compose -f ./compose/docker-compose.yml up
4. Make migrations and create superuser:
   • Enter shell: docker exec -it sport_adminpanel bash
   • Autocreate migration files: python manage.py makemigrations
   • Apply migrations to db: python manage.py migrate

     If there are problems with migrations applying, try to run the same migrate command with --fake option.

   • Create a new superuser: python manage.py createsuperuser
5. View admin panel at http://localhost/admin

[!NOTE] Server supports auto-reload on code change in debug mode

API documentation:

• Swagger is at http://localhost/api/swagger
• Redoc is at http://localhost/api/redoc

Environment Variables

See compose/example.env for reference.

The project requires a file compose/.env with the following environment variables:

• POSTGRES_USER- Username for the db
• POSTGRES_PASSWORD- database password
• POSTGRES_DB - database name
• POSTGRES_SERVER - database hostname (db - by default)
• GRAFANA_DB_USER - username for database user for grafana (will be created if not exists)
• GRAFANA_DB_PASSWORD - password for database grafana user
• GF_SECURITY_ADMIN_PASSWORD - admin password for Grafana Dashboard
• SECRET_KEY - a secret key for token verifications
• PROJECT_NAME- project title
• SCHEMA - schema of a web page (prefer https)
• HOSTNAME - hostname of a web page e.g: example.com
• PORT - port over which web page is served
• PYTHON_VERSION - which python version is to be used (specify exact version)
• DEBUG- boolean flag for DEBUG mode ( true enables fake login and Django debug)
• oauth_appID - application ID for oauth
• oauth_shared_secret - application secret for ouath
• oauth_authorization_baseURL- an URL for user auth
• oauth_get_infoURL- tokeninfo URL
• oauth_tokenURL- an URL to obtain token
• oauth_end_session_endpoint- end oauth session endpoint

You can leave the default values for development.

Project structure

.
├── adminpage - Django project
│   ├── adminpage - main django app
│   │   ├── settings.py
│   │   ├── swagger.py
│   │   ├── urls.py
│   │   └── wsgi.py
│   ├── api
│   │   ├── crud - directory with database queries
│   │   ├── fixtures - database tools for testing
│   │   ├── serializers - DRF serializers
│   │   ├── tests
│   │   │   ├── api - endpoints tests
│   │   │   └── crud - database queries tests
│   │   └── views - api endpoints
│   ├── sport
│   │   ├── admin - django adminpage classes
│   │   ├── dumps - database dumps for tests
│   │   ├── migrations - django database migrations
│   │   ├── models - django database models
│   │   ├── signals - django ORM signal handlers
│   │   ├── static - static files for app (css, fonts, images, js)
│   │   │   └── sport
│   │   │       ├── css
│   │   │       ├── fonts
│   │   │       ├── images
│   │   │       └── js
│   │   ├── templates - django templates for app pages
│   │   └── views - app pages url handlers
├── compose - compose for the project
│   └── docker-compose.yml
├── nginx - load balancer and proxy
│   ├── access.d
│   ├── conf - configuration folder
│   ├── Dockerfile
│   └── logs - log folder
└── README.md