redd4ford / social-network

social-network

This project was developed with: Python 3.8, Django 4.0.7, PostgreSQL 14

Uses libraries: Django Rest Framework, DRF-Spectacular, DRF-Nested-Routers, SimpleJWT, DRF-YASG & Swagger, Django-Environ, Django-Filter, Django-Injector, Django-Prometheus.

---

Setup

Manual

• Create venv: python -m venv /path/to/venv
• Activate venv:
  • Linux/MacOS: source venv/bin/activate
  • Windows: venv\Scripts\activate
• Install requirements: pip install -r requirements.txt
• Create a PostgreSQL database
• Create socialnetwork/.env file based on .env.example
  • To generate SECRET_KEY, use: python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'
• Run migrations: python manage.py migrate
• Start the server: python manage.py runserver
• Find the OpenAPI here: http://127.0.0.1:8000/schema/swagger-ui/#/

Using Docker

Docker-compose creates four containers:

1. db for PostgreSQL 14 image;
2. api for the Django app;
3. prometheus for Prometheus, the monitoring tool;
4. grafana for Grafana, the monitoring metrics visualization tool. Grafana's container comes with a pre-imported dashboard from here.

• Create socialnetwork/.env file based on .env.example
  • To generate SECRET_KEY, use: python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'
  • If you want to make the app accessible via LAN or globally, you'll need to add your local/global IP address to DJANGO_ALLOWED_HOSTS. Otherwise, leave the default values.
• Run docker-compose: docker-compose up -d
• You can check the logs:
  • To get the last 100 log lines: docker logs api --tail 100
  • To attach to the container's logs: docker logs --follow api
• Or get inside the container: docker exec -it api /bin/bash
• Find the OpenAPI here: http://127.0.0.1:8000/schema/swagger-ui/#/
• Find Grafana here: http://127.0.0.1:3000/
• Find Prometheus metrics here: http://127.0.0.1:9090/

---

Implemented

• Models: User, Post, Like
• Endpoints: Post CRUD, Post like/unlike, User sign up/sign in/sign out/refresh (JWT-based), user activity, likes analytics (by post, by user, by dates (date_from, date_to))