Skip to content

thrila/chatboard-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ChatBoard API

A Flask + Supabase REST API backend for a forum system with chat support.
Designed for easy integration with any frontend (React, Flutter, etc.).


Features

  • User Management: Register, authenticate, manage profiles.
  • Forum: Create posts, reply to threads.
  • Chat: Send and retrieve chat messages (real-time ready with Supabase).
  • REST Principles: Clean, JSON-based endpoints for frontend consumption.

Database Schema

Open modal.mwb in MySQL Workbench (or any .mwb viewer) to view tables and relationships.


How to Run

  1. Clone the repository

    git clone <repo_url>
    cd <project_folder>
  2. Create a virtual environment

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
  3. Install dependencies

    pip install -r requirements.txt
  4. Set up Supabase

    • Create a Supabase project.
    • Create tables matching modal.mwb schema.
    • Retrieve your SUPABASE_URL and SUPABASE_KEY.
  5. Create a .env file:

    SUPABASE_URL=<your_supabase_url>
    SUPABASE_KEY=<your_supabase_key>
    FLASK_APP=run.py
    FLASK_ENV=development
    
  6. Start the API server

    flask run

    (If your entry file differs, adjust accordingly, e.g., python run.py.)


🧪 Testing the API

Use Postman or Insomnia to test endpoints locally.


📜 License

MIT


About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages