SkDev Backend

Backend service for SkDev built with FastAPI. Handles authentication (JWT), LLM-powered responses (OpenAI), and roadmap generation.

Getting Started

Prerequisites

• UV
• Docker
• Make (Windows only, if you want to use the provided Makefile commands)

Environment variables

This repository includes a .env-example file. Copy it to .env and fill in the required values before running the application.

cp .env-example .env

Setup

git clone https://github.com/0SkDev/Backend.git
cd Backend
uv sync
make run-dev

Access the API

Once the development server is running, go to:

http://localhost:8000

You can also access the interactive API documentation at:

http://localhost:8000/docs

Development

Install Make (Windows only)

This project uses Make to simplify common development tasks such as linting, formatting, testing, documentation, and Docker commands. You can find Make for Windows here.

uv sync --extra dev
make run-dev

Development Commands

Command	Description
make run-dev	Run the development stack with Docker Compose
make lint	Run Ruff linting and apply autofixes
make format	Format the codebase with Ruff
make typecheck	Run MyPy type checking
make test	Run the test suite with Pytest
make docs-run	Generate the documentation locally with Pdoc
make docs-build	Build the documentation into docs/
make docs-serve	Serve the generated docs locally
make container-build	Build the Docker image
make container-run	Run the Docker image