Skip to main content

​
1. Clone the Repository

git clone https://github.com/meeran03/burki.git
cd burki

​
2. Choose Your Setup Method

  • Tab Title
  • Tab Title
  • Tab Title

​
Python Environment

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

​
Database Setup

​
Environment Variables

cp .env.example .env
# Edit .env with your API keys and settings

​
Run the App

python app/main.py
Visit http://localhost:8000

​
3. Environment Variables

  • 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

  • Database connection errors:
    • Check your database URL and credentials
    • Make sure PostgreSQL is running
  • Missing dependencies:
    • Run pip install -r requirements.txt again
  • 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

​
5. Next Steps