diff --git a/.gitignore b/.gitignore index e085e65..ae53350 100644 --- a/.gitignore +++ b/.gitignore @@ -130,6 +130,8 @@ celerybeat.pid # Environments .env +.env.dev +.env.prod .venv env/ venv/ diff --git a/README.md b/README.md index 4ba37b7..2a91492 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,52 @@ -# kebuu.com +# Kebuu -Spending Tracker \ No newline at end of file +A spending tracker web application built with Flask. + +## Setup + +### 1. Install Dependencies + +```bash +cd src +pip install -r requirements.txt +``` + +### 2. Create Environment Files + +Copy the example file and configure for your environment: + +```bash +cp .env.example .env.dev # For development +cp .env.example .env.prod # For production +``` + +Edit the files with your values: + +| Variable | Description | Example | +|----------|-------------|---------| +| `SECRET_KEY` | Flask session secret (use a strong random string in production) | `your-secret-key-here` | +| `DATABASE_URL` | Database connection string | `sqlite:///kebuu.db` or `postgresql://user:pass@host/db` | +| `ALTCHA_HMAC_KEY` | CAPTCHA signing key (use a strong random string) | `your-altcha-hmac-key-here` | + +Generate secure keys with: +```bash +python -c "import secrets; print(secrets.token_hex(32))" +``` + +### 3. Run the Application + +**Development:** +```bash +cd src +python app.py +``` + +**Production (Docker):** +```bash +docker build -t kebuu . +docker run -p 5000:5000 --env-file .env.prod kebuu +``` + +## Project Structure + +See [CLAUDE.md](CLAUDE.md) for detailed project documentation.