Skip to content

dqyaa/aska-chatbot

Repository files navigation

ASKA Project - AI Learning Chatbot

ASKA is a WhatsApp-based AI learning assistant designed to deliver an AI Bootcamp, facilitate general learning, and engage in casual conversation.

Table of Contents

  1. Prerequisites
  2. Project Structure
  3. Setup Instructions
  4. Running the Application
  5. Key Scripts Overview
  6. Important Considerations

Prerequisites

  • Python 3.8+
  • pip (Python package installer)
  • Access to a Supabase project.
  • Access to a Google Cloud Platform project.
  • A Meta (Facebook) Developer account and an App configured for the WhatsApp Business API.
  • ngrok (or a similar tunneling service) for local development if you want to test WhatsApp webhooks.

Project Structure

Ensure your project files are organized as follows (this README assumes all Python scripts are in the same main directory, e.g., ASKA/): ASKA/ ├── bootcamp_lessons/ # Directory for bootcamp chapter and quiz files │ ├── Chapter 1.txt │ ├── Quiz 1.txt │ ├── Answer 1.txt │ └── ... (other chapters and quizzes) ├── main.py # FastAPI application, WhatsApp message handling ├── database.py # Supabase database interactions ├── bootcamp_manager.py # Logic for bootcamp progression, content loading ├── llm_integrations.py # DeepSeek LLM API interactions ├── state_prompts.py # Manages response templates for different states ├── config.py # Loads environment variables and configurations ├── google_sheet_to_supabase.py # Syncs data from Google Sheets to Supabase ├── requirements.txt # Python package dependencies ├── .env # Environment variables (create this file) └── README.md # This file

Setup Instructions

1. Clone/Download Files

Ensure all the project files (main.py, config.py, database.py, etc.) are in your chosen project directory.

2. Create a Virtual Environment

It's highly recommended to use a virtual environment to manage project dependencies.

python -m venv venv

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages