This is a mini project to learn the Django Framework (2.0), Docker/docker-compose, Pytest/Selenium and Gitlab CI ( Continuous Integration)
- The User signs up/in using Facebook or username/password
- The user can reset his password by receiving an email
- The user can change his personal info
- User can submit/edit/delete a new Topic
- User can upvote/cancel upvote a Topic
- User can comment/delete comment a Topic
- The user can see all his statistics (posted topics, upvoted, commented)
- User can sort Topics by 'Most Recent' & 'Most Rated'
- User can see number of upvotes/comments by Topic
- User can click on 'more' to see the next 20 Topics
Client ------------- (4433) NGINX <-------> (8000) Django App (GUNICORN) <-----> (5432) PostgreSQL
The Project is set up using docker-compose and divided into three components:
- The Web Server (NGINX): listening on port 4433 (HTTPS) and reverse proxying to the App server (also on HTTPS)
- The App Server (GUNICORN): is the Django App listening on port 8000 and configured to accept HTTPS
- The DB Server(PostgreSQL): Database all managed by Django's ORM and pyscopg2 (python adapter for postgres)
The tests are performed using pytest ( coupled with selenium for UI ), and are grouped in the djangonews/topics/tests folder.
There are 2 types of tests:
- Unit Tests: Tests on individual models, forms
- Integration Tests: Tests on Views and UI (Selenium)
The test coverage is of about 92%
Gitlab CI was used for continuous integration. A custom runner installed in Amazon EC2 was used for handling the pipeline.
The file gitlab-ci.yml specifies 3 stages: test, build and deploy.
