Unearth Hidden Gems of Georgian Language and Culture

Test User Experience

You can test user experience with these login credentials:

Username	Password
TestUserGeogem	5xPzUpKFZiQcHRa

Installation

1. Create a virtual environment and activate it:

python -m venv venv && venv\Scripts\activate

2. Install required dependencies:

python -m pip install -r requirements.txt

3. Create a .env file in the root directory of the project:

DJANGO_SECRET_KEY=your_django_secret_key

SQL_ENGINE=django.db.backends.postgresql
SQL_DATABASE=geogem
SQL_USER=geogem
SQL_PASSWORD=your_password
SQL_HOST=postgres
SQL_PORT=5432
PGDATA=/data/geogem-postgres
PG_CONTAINER_NAME=geogem-postgres

CELERY_BROKER=redis://redis:6379/0
CELERY_BACKEND=redis://redis:6379/0

WEB_CONTAINER_NAME=geogem
REDIS_CONTAINER_NAME=geogem-redis
CELERY_BEAT_CONTAINER_NAME=geogem-celery-beat
CELERY_WORKER_CONTAINER_NAME=geogem-celery-worker

[email protected]
[email protected]
EMAIL_HOST_PASSWORD=your_password

# These are official recaptcha test keys which are used during development
RECAPTCHA_PUBLIC_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
RECAPTCHA_PRIVATE_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe

ALLOWED_HOSTS=127.0.0.1 localhost
CSRF_TRUSTED_ORIGINS=http://127.0.0.1 http://localhost

DEBUG=1

• Create a .env.dev with the same values as .env except SQL_HOST and WORKERS_RUNNING:

SQL_HOST=localhost
WORKERS_RUNNING=

# You may remove these variables at all

.env.dev is utilized in conjunction with docker-compose-lite.yml, which includes only a PostgreSQL container with port 5432 exposed. The WORKERS_RUNNING environment variable is used to skip tests involving Celery workers, such as sending emails during account activation.

By default, django-admin startproject creates an insecure SECRET_KEY (see Django docs). Generate a secure django secret key for your project:

python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'

4. Create a Docker volume:

docker volume create geogem_postgres_data

5. Build and start Docker containers with Celery services:

docker-compose up -d --build

Note

Celery doesn't support Windows since version 4, so you can either run Celery in Docker containers (our case) or use a UNIX system to run each Celery process manually, each from a different terminal window:

celery -A geogem worker -l INFO
celery -A geogem beat -l INFO

6. Make migrations and migrate:

python manage.py makemigrations && python manage.py migrate

7. Load data for token types from a fixture:

python manage.py loaddata accounts/fixtures/token_types.json

8. Create a super user:

python manage.py createsuperuser

9. Manually create a profile for the super user:

python manage.py shell

from django.contrib.auth import get_user_model
from accounts.models import Profile

User = get_user_model()
super_user = User.objects.get(is_superuser=True)
Profile.objects.create(user=super_user)

exit()

10. Collect all the static files into a single static directory:

python manage.py collectstatic

11. Before deploying to production, set DEBUG to False in .env by not assigning any value to DEBUG:

DEBUG=

• If your docker-compose.yml is up, webserver will be available at http://127.0.0.1:8005
• If your docker-compose-lite.yml is up, start a development server:

python manage.py runserver

Dump database (Georgian characters)

python -Xutf8 manage.py dumpdata > data.json doesn't correctly encode Georgian characters in utf-8, so use django-dump-load-utf8 library to dump your database:

python manage.py dumpdatautf8 --output data.json

Load the database with Georgian characters:

python manage.py loaddatautf8 data.json

Tests

There are 205 test functions. Current code coverage is 96% (Celery tasks and admin page functions are not tested).
coverage tool is used to measure code coverage. You will get correct results if you run tests within geogem Docker container:

docker exec -it geogem bash

# OR

docker-compose exec -it web bash

coverage run manage.py test

All tests are located in every app's tests folder.
To make tests run faster, geogem/test_settings.py is used which includes a simpler password hashing algorithm:

coverage run manage.py test --settings=geogem.test_settings

Get a code coverage report:

coverage report

Get annotated HTML listings with missed lines:

coverage html

Head to the created htmlcov folder and open index.html with Live server

Tech Stack

The aspects of Django framework that were used during development of this project:

• Class-based views (View, DetailView, FormView, ListView, DeleteView, TemplateView, RedirectView)
• CustomUser model, forms (UserLoginForm, UserCreationForm)
• Mixins (LoginRequiredMixin, SuccessMessageMixin)
• Internationalization (English, Russian)
• Static and media files
• ORM with PostgreSQL
• JavaScript, jQuery, Ajax requests & Chart.js
• CSS & DataTables, Bootstrap v5.3.2 (makes for a visually-appealing and mobile-friendly interface)
• Django-recaptcha
• Email Confirmation Upon Registration
• Reset Forgotten Password feature
• Docker and docker-compose.yml files
• Environment variables (separate .env files for development and production)
• Customized admin page: SimpleListfilter, EmptyFieldListFilter
• Unit Tests (models, views, templates and forms), coverage module
• Fixtures with test data
• Custom management commands (report number of users and user words)
• Celery workers (sending links for email confirmation and password reset in the background)
• Celery beat (deleting expired tokens and sessions at midnight)