Skip to content
Courses/Aulafy foundations/Base project ready for Aulafy

Base project ready for Aulafy

We close onboarding by creating a minimal template you can reuse in RAG, agents, MLOps, or local AI courses.

Recommended structure

TerminalCode
aulafy-project/
  AGENTS.md
  README.md
  .env.example
  .gitignore
  pyproject.toml
  src/
    main.py
  data/
    .gitkeep
  scripts/
    verify.sh
  docker-compose.yml

Minimum README

TerminalCode
# Aulafy Project

## Requirements
- uv
- Docker Desktop optional
- Ollama optional

## Start
uv venv
source .venv/bin/activate
uv sync

## Verification
bash scripts/verify.sh

Verification script

TerminalCode
#!/usr/bin/env bash
set -euo pipefail

uv run python -m compileall src
uv run python src/main.py

echo "OK: verifiable project"

Checklist before moving on

  • The project starts from scratch by following the README.
  • There are no secrets or private data in Git.
  • There is a clear command to verify it works.
  • AGENTS.md explains how AI should work in that repository.

Once you have this, advanced courses stop being a collection of commands and become projects you can maintain.