Getting Started
Set up your development environment and start building.
Prerequisites
| Tool | Version | Purpose |
|---|---|---|
| Python | 3.11+ | Runtime environment |
| Docker | 24.0+ | Containerization |
| PostgreSQL | 15+ | Database (via Docker) |
| Redis | 7+ | Caching (via Docker) |
Installation
1. Clone the Repository
Terminal
git clone https://github.com/yourorg/forgeapi.git
cd forgeapi2. Set Up Environment
Terminal
# Copy environment template
cp .env.example .env
# Edit with your values
nano .env3. Start Services
Terminal
# Start all services with Docker
docker-compose up -d
# Check status
docker-compose psSuccess!
Your API is now running at
http://localhost:8000Environment Variables
These environment variables are required for the application to function properly. Missing values will cause startup failures.
| Variable | Description | Example |
|---|---|---|
SECRET_KEY | JWT signing key and general encryption | your-super-secret-key |
DATABASE_URL | PostgreSQL connection string | postgresql://user:pass@localhost/db |
REDIS_URL | Redis connection string | redis://localhost:6379 |