1. Clone the Repository
2. Choose Your Setup Method
Python Environment
Database Setup
PostgreSQL (Recommended)
PostgreSQL (Recommended)
- Install PostgreSQL (if not already installed)
- Create a database (e.g.,
burki_db
) - Update your
.env
file with the database URL - Run migrations:
Environment Variables
Run the App
3. Environment Variables
What do I need to set?
What do I need to set?
- Database URL (e.g.,
postgresql://user:pass@localhost:5432/burki_db
) - Twilio Account SID & Auth Token
- API keys for LLM, TTS, and STT providers
- Other settings (see
.env.example
for all options)
4. Troubleshooting
Common Issues & Solutions
Common Issues & Solutions
- Database connection errors:
- Check your database URL and credentials
- Make sure PostgreSQL is running
- Missing dependencies:
- Run
pip install -r requirements.txt
again
- Run
- Port already in use:
- Change the port in your run command or stop the conflicting process
- API key errors:
- Double-check your keys and provider dashboards