Private Notes - Both Title and Content are encrypted with Fernet before saving. Only the owner can decrypt and read them.

Passwords - Hashed (Argon2)

🛠 Tech Stack

• Framework: FastAPI (Async)
• Database: PostgreSQL 15 (Asyncpg driver)
• Caching: Redis (Async)
• ORM: SQLModel (SQLAlchemy + Pydantic)
• Migrations: Alembic
• Authentication: Python-JOSE & Passlib (Argon2)
• Config: Pydantic-Settings

🚀 Installation & Setup (Step-by-Step)

Follow these steps to run the project from scratch.

1. Clone the Repository

git clone https://github.com/YOUR_USERNAME/fastapi-docker-secure-note.git
cd fastapi-docker-secure-note

2. Create Environment Variables (.env)

For security reasons, secrets are not stored in the repository. You need to create a .env file. You have two options:

Option A: Automatic Setup (Recommended) ⚡

Run the included Python script to generate a secure .env file with cryptographically strong keys:

python generate_env.py

Option B: Manual Setup 🛠️

Create a file named .env in the root directory and paste the content below. (Note: You must generate your own secure values for SECRET_KEY and ENCRYPTION_KEY).

POSTGRES_USER=postgres
POSTGRES_PASSWORD=password
POSTGRES_DB=securenote_db
REDIS_HOST=redis
REDIS_PORT=6379

# Replace these with strong, random keys!
SECRET_KEY=change_this_to_a_very_long_random_secret_string
ENCRYPTION_KEY=change_this_to_a_valid_fernet_key

3. Start Containers

Build and start the services in detached mode:

docker-compose up -d --build

4. Create Database Tables (Crucial Step)

docker-compose exec web alembic upgrade head

🧪 Usage & Testing

Option A: Swagger UI (Browser)

• Visit http://localhost:8000/docs to explore the interactive API documentation.
• Use /auth/register to create a new user.
• Use /auth/token to login and copy the access_token.
• Click the Authorize button at the top right and paste the token.
• Use /notes/search to search for notes by keyword.

Option B: CLI Client (Terminal)

You can use the included Python script to test the API interactively:

# Install requests if not already installed: pip install requests
python client_test_app.py

The client saves your login tokens to a local session.json file, so you don't have to login every time.

🛠️ Developer Notes (Cheat Sheet)

If you modify the database models (e.g., adding a new field in models.py), follow these commands:

• 1. Create a New Migration (Plan) docker-compose exec web alembic revision --autogenerate -m "description_of_changes"  
• 2. Apply Changes to Database (Upgrade) docker-compose exec web alembic upgrade head

🛠️ DB Reset

If you want to wipe everything (including data) and start fresh:

• Delete old migration files inside alembic/versions/ (keep pycache).
• Remove the Docker volume: docker-compose down -v
• Restart containers: docker-compose up -d --build
• Create initial migration: docker-compose exec web alembic revision --autogenerate -m "initial"
• Apply migration: docker-compose exec web alembic upgrade head

📂 Project Structure

├── alembic/ # Database migration scripts
├── app/
│ ├── routers/ # API Endpoints (Auth, Notes)
│ ├── models.py # Database Models (User, Note, Token)
│ ├── crud.py # Database Operations (Create, Read...)
│ ├── auth.py # JWT, Hashing, and Security Logic
│ ├── redis_client.py # Redis Connection Manager │ ├── config.py # Settings Management (.env reading)
│ └── main.py # Application Entry Point
├── client_test_app.py # Terminal Testing Client
├── docker-compose.yml # Docker Services Configuration
└── Dockerfile # Python Environment Definition

🗺️ Roadmap

This project is actively being developed. Here are the planned features for upcoming releases:

• Core Backend API (FastAPI, SQLModel, PostgreSQL)
• Advanced Security (JWT, Argon2, Rotation)
• Encryption at Rest (AES/Fernet)
• Docker & Compose Infrastructure
• CLI Client
• Refactored Async Codebase
• Redis Caching Implementation
• Comprehensive Unit Tests (Pytest)
• Frontend Web UI (Planned: Streamlit Dashboard)
• Deployment to Cloud (Render)