Skip to content

Latest commit

 

History

History
190 lines (134 loc) · 5.9 KB

README.md

File metadata and controls

190 lines (134 loc) · 5.9 KB

HackForHer Health

Contributors Forks Stargazers Issues MIT License


Logo

HackForHer Health

An All-in-One Platform for Cervical Cancer Awareness and Support
Explore the docs »

About The Project

HackForHer Health is a comprehensive platform dedicated to cervical cancer awareness, support, and early detection. Our mission is to empower individuals with knowledge, provide predictive tools, and facilitate seamless medical support.

Key Features

  • Cervical Cancer Awareness: Latest news, symptoms, FAQs, myth busters
  • Survivor Stories: Inspiring narratives to provide hope and support
  • Predictive Model: AI-powered cervical cancer prediction with 95-98% accuracy
  • Medical Case Management:
    • Create and manage medical cases
    • Fill predictive questionnaires
    • Doctor case review
  • Telemedicine Features:
    • Real-time doctor-patient communication
    • Appointment scheduling
    • Secure chat functionality

Built With

  • Spring Boot
  • PostgreSQL
  • Flask
  • React

Project Status

Important Note: This project is now in a completed state. No further development is planned.

Screenshots

Project Walkthrough

Demonstration

Getting Started

Prerequisites

Before setting up the project, ensure you have the following installed:

  • Maven
  • PostgreSQL Database
  • Anaconda Environment
  • Node.JS 20

Installation

  1. Clone the repository

    git clone https://github.com/ujjwalgarg100204/hackforher-health.git
  2. Create sensitive.properties Navigate to src/main-server/src/main/resources/ and create sensitive.properties:

    # DB configuration
    spring.datasource.url=jdbc:postgresql://localhost:5432/<db_name>?useSSL=false
    spring.datasource.username=<postgresql-username>
    spring.datasource.password=<postgresql-password>
    # Security configuration
    my.jwt.secret.key=<secret-key>
  3. Create .env files

    • In src/main-server/src/main/client/, create .env.development:

      VITE_API_BASE_URL=http://localhost:8080/api
    • Create .env.production:

      VITE_API_BASE_URL=/api
  4. Install dependencies

    # Install backend dependencies
    mvn clean install
    
    # Install frontend dependencies
    cd src/main-server/src/main/client
    pnpm install
  5. Start the application

    # Start backend
    mvn spring-boot:run
    
    # Start model micro-service arch
    cd src/model-microservice/
    flask run

Core Contributors

A special thank you to the core developers who made this project possible:

Naman Rath

GitHub

  • Machine learning model development

Utkarsh Shukla

GitHub

  • User interface design
  • Documentation

Project Completion

This project represents a comprehensive solution for cervical cancer awareness and support. While no further development is planned, the existing codebase provides a robust platform for:

  • Cancer risk assessment
  • Patient-doctor communication
  • Medical case management
  • Health awareness resources

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

For any queries about the project, please reach out to the core contributors:

Acknowledgments

  • Special thanks to all who supported the HackForHer Health project
  • Our dedicated healthcare professionals