How karippery/smartskill works
Project type and purpose
• This is a Docker-containerized, Django-based full-stack (back-end/API) application called Smart-Skill.
• It exposes a REST API (Django REST Framework + JWT), uses Celery for background tasks, Redis for caching/broker, and PostgreSQL as its primary datastore.
• Purpose: manage employee skills, track levels, match candidates to projects, provide secure access, and generate fake/test data.
File structure
• Top-level files:
• Dockerfile & docker-compose.yml (build & orchestrate containers)
• manage.py (Django CLI)
• requirements.txt, .flake8, .gitignore
• apps/ – five domain modules (experiences, projects, qualifications, skills, user), each with models, serializers, views, URLs, tests, and management commands to generate fake data.
• core/ – project settings, ASGI/WSGI entrypoints, Celery config, caching utilities, common helpers and exception classes, and site-wide management commands.
• doc/ – proposal, Postman collection, markdown art and images.
Insights from the README
• Tech stack: Python 3.10, Django 4.2, DRF, JWT, Celery, Redis, PostgreSQL, Docker, PgAdmin, Swagger/ReDoc.
• Features: JWT-secure login, CRUD APIs, schema & interactive docs, fake data generation, caching, async tasks, email via SendGrid/SMTP.
• Environment variables define DB, email, API version, secrets.
Diagramming conventions
• Containers (light blue)
• Datastores (light green)
• External services (light orange)