Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 2.61 KB

README.md

File metadata and controls

90 lines (61 loc) · 2.61 KB

mkunga-chatbot

Overview

Mkunga is chatbot designed to provides culturally relevant information on menstrual health, maternal health, and menopause for african girls and women.

Features

1. Educate

  • Highlights the links between menstrual health, maternal health, and menopause.
  • Explains how menstrual health can predict maternal health outcomes.
  • Discusses how maternal health impacts menopause experiences.

2. Empower

  • Provides culturally relevant advice for managing life stages.
  • Delivers actionable health tips tailored to African women.

3. Support

  • Offers a safe space for discussing sensitive health topics.
  • Provides empathetic responses and emotional support.

4. Advocate

  • Raises awareness about the importance of early interventions and accessible healthcare.
  • Promotes better health outcomes through knowledge sharing.

5. Multilingual Support

  • Supports multiple languages, starting with Swahili and expanding to other African languages.

Technology Stack

Backend

  • Ruby on Rails: Web application framework for building API endpoints.
  • LLM Integration: Powered by Ollama with models like Llama 3.2 for natural language processing.

Frontend

  • Bootstrap 5: Responsive design for user-friendly chatbot interface.

Database

  • PostgreSQL: To store user interactions and relevant content.

Deployment

  • Render: For hosting and managing the chatbot’s backend services.

Additional Tools

  • RSpec: For testing API endpoints and ensuring functionality.
  • Multilingual Libraries: To support content localization and translations.

Getting Started

Prerequisites

  1. Ruby: Install via a manager like asdf or use the Rails 8 installation guide.
  2. Rails: Install the latest version using gem install rails.
  3. Ollama: Install and download the llama3.2 model for the chatbot.

Setup

  1. Clone the repository: 
    git clone https://github.com/your-repo-name.git
cd african-womens-health-chatbot
  2. Install dependencies: 
    bundle install
  3. Run the application: 
    rails server

Contributing

We welcome contributions to expand the chatbot’s features and improve its content. Please read the CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License.

Acknowledgments

  • Inspired by the need for better health resources tailored to African women.
  • Thanks to the contributors and healthcare professionals who reviewed the content.