Skip to content

myshkin42/workers-rights-chatbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Workers’ Rights Chatbot

An AI-powered assistant that helps workers in Australia access information about their workplace rights, health & safety, awards, and union representation.

⚠️ Disclaimer: This chatbot provides general information only. It does not provide legal advice. For specific issues, please contact your union, HR, or a legal professional.


🚀 Quick Start

# Clone and run backend
git clone https://github.com/YOUR-USERNAME/workers-rights-chatbot.git
cd workers-rights-chatbot/backend
python -m venv .venv && .venv\Scripts\activate
pip install -r requirements.txt
cp .env.example .env  # add your API keys
python -m app.main

# In another terminal, run frontend
cd ../frontend
npm install
cp .env.example .env  # add your frontend token if needed
npm start

✨ Features

  • Retrieval-Augmented Generation (RAG) using Pinecone for workplace documents
  • Profession + location-aware responses
  • Multilingual support: English, Arabic, Chinese, Spanish, Hindi, Vietnamese, Swahili
  • Simple React frontend with chat-style interface
  • “Popular Questions” panel to help users get started
  • Designed to be extensible for unions, workplaces, or future apps

🗂 Project Structure

workers-rights-chatbot/
├── backend/              # FastAPI backend
│   ├── app/              # Core Python code
│   ├── requirements.txt
│   ├── dockerfile
│   ├── fly.toml
│   └── .env.example
│
├── frontend/             # React frontend
│   ├── public/
│   ├── src/
│   ├── package.json
│   └── .env.example
│
├── data/
│   ├── sample-documents/ # Example files (award, union, guide)
│   └── README.md         # Notes on full corpus
│
└── docs/                 # Milestones, notes, design docs

⚡ Sample Data

This repo includes a few example documents under data/sample-documents/ so ingestion and testing works without downloading a full corpus.
To use the chatbot seriously, add Acts, Awards, or Guides under data/documents/ (ignored in GitHub).


🛠 Tech Stack

  • Backend: FastAPI, Redis (optional), Pinecone, OpenAI
  • Frontend: React, i18next (translations)
  • Deployment: Fly.io + Docker

🤝 Contributing

Pull requests welcome! For big changes, please open an issue first to discuss what you’d like to add.


📜 License

To be confirmed. For now: private use only.

About

AI chatbot to help Australian workers access workplace rights & safety info.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors