Add .env files to gitignore and update README with setup instructions

- Add .env.dev and .env.prod to .gitignore
- Document environment variable configuration in README
- Include instructions for generating secure keys

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
2026-01-19 20:40:00 -05:00
parent 49ef87ea50
commit 10407415f0
2 changed files with 53 additions and 2 deletions

2
.gitignore vendored
View File

@@ -130,6 +130,8 @@ celerybeat.pid
# Environments
.env
.env.dev
.env.prod
.venv
env/
venv/

View File

@@ -1,3 +1,52 @@
# kebuu.com
# Kebuu
Spending Tracker
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.