Skip to content

Latest commit

 

History

History
126 lines (95 loc) · 4.55 KB

README.md

File metadata and controls

126 lines (95 loc) · 4.55 KB
Raw

Mindscape

Overview

Mindscape is a web platform built using React and FastAPI, aiming to promote mental wellness through community engagement, personal tracking, and curated resources. It serves as a safe space where users can connect with peers, monitor their emotional health, and access professional support tools.

Screenshot 2024-11-16 at 1 38 50 AM

Features

Community Support

Mindscape provides a peer-driven support system, enabling users to:

  • Share experiences in a judgment-free environment.
  • Join support groups tailored to specific mental health challenges such as anxiety or depression.
  • Participate in discussions and receive encouragement from others.
Screenshot 2024-11-16 at 1 39 36 AM

Mood Tracking

Track emotional well-being with:

  • An intuitive interface for logging moods daily.
  • Calendar views for visualizing mood trends over time.
  • Insights into patterns of emotions like joy, sadness, anger, and fear.
Screenshot 2024-11-16 at 1 39 54 AM Screenshot 2024-11-16 at 1 40 18 AM

Sentiment Analysis

  • Analyze emotional trends using a sentiment analysis tool.
  • View detailed emotion breakdowns for individual entries.
  • Track metrics like dominant emotions, sentiment scores, and emotional averages over time.
Screenshot 2024-11-16 at 1 40 33 AM Screenshot 2024-11-16 at 1 45 29 AM

Self-Care Resources

Mindscape offers a variety of self-care tools, including:

  • Guided meditation exercises.
  • Breathing techniques for stress relief.
  • Sleep hygiene tips and stress management resources.
Screenshot 2024-11-16 at 1 39 06 AM

Local Mental Health Resources

Users can find nearby support, such as:

  • Therapists, clinics, and holistic health centers with contact information and locations.
  • Crisis support resources, including 24/7 hotlines and emergency contacts.

Support Bot (Powered by Groq LLM)

Mindscape’s intelligent chatbot provides:

  • Immediate assistance by answering questions or directing users to relevant resources.
  • Support forums where users can discuss topics like mindfulness, anxiety, and recovery.
Screenshot 2024-11-16 at 1 40 58 AM

Technical Stack

Frontend

  • React.js: For creating a dynamic and responsive user interface.
  • Tailwind CSS: To ensure a modern and accessible design system.

Backend

  • FastAPI: For building a high-performance, RESTful API backend.
  • Groq LLM: Enhancing user interactions with natural language processing capabilities.

Database

  • Structured to store user profiles, mood entries, and community discussions efficiently.

Installation and Setup

Prerequisites

Ensure the following tools are installed:

  • Node.js and npm
  • Python 3.x and pip

Steps

  1. Clone the repository:

    git clone https://github.com/omkar-334/mindscape.git
cd mindscape

  2. Install dependencies:

    • For the frontend: 
      npm install
    • For the backend: 
      pip install -r requirements.txt

  3. Run the backend server:

    uvicorn main:app --reload

  4. Run the frontend server:

    npm start

  5. Open the app in your browser at http://localhost:5173 (frontend) and http://localhost:8000 (backend).

Contribution

Mindscape is an open-source project. Contributions are welcome to enhance features or address issues.

How to Contribute

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature-name
  3. Make your changes and commit them: 
    git commit -m "Description of changes"
  4. Push the branch and submit a pull request.

Mindscape: Your journey to better mental health begins here.