/mindful

Promoting mental health in the Aptos ecosystem

Primary LanguageTypeScriptApache License 2.0Apache-2.0

MINDFUL

Peace and tranquility for us all

Table of Contents

Description

This wonderful Aptos blockchain application platform enables users to talk and share about their mental struggles in different areas. It is designed to support individuals in their journey towards mental health and addiction recovery. Users can join in anonymous virtual meetings to cater for everyone around the globe. It also provides a platform for users to connect with therapists around the world and get crisis responses like suicide prevention hotlines.

Features

The application provides:

  • Post and View - User-friendly interface for posting and viewing community messages
  • Wallet implementation - Secure authentication using Aptos wallet
  • Virtual Anonymous Meetings - Virtual support group meetings through Google meet for now
  • Therapist Board - Showing a list of professional therapist who are able to help the community

Installation

To set up the project locally, follow these steps:

  1. Clone the repository:

    git clone git@github.com:JamesKm08/mindful.git
    
  2. Navigate to the project directory:

    cd mindful
    
  3. Install dependencies:

    npm install
    
  4. Set up environment variables:

    • Create a .env file in the root directory
    • Add necessary environment variables
  5. Publish contract using your own module address and change the necessary files

    npm run move:publish
    
  6. Start the development server:

    npm run dev
    

Usage

  1. Connect your Aptos wallet to the application.
  2. Navigate to the meetings section to view available support group meetings.
  3. Click on a meeting to join
  4. Use the main page to share thoughts or read community posts.

Technologies

  • React framework
  • TypeScript
  • Vite development tool
  • Aptos TS SDK
  • Aptos Wallet Adapter
  • TanStack Query (React Query)
  • Tailwind CSS
  • shadcn/ui components
  • Node based Move commands

Contributing

We welcome contributions to Mindful! Please follow these steps to contribute:

  1. Fork the repository
  2. Create a new branch: git checkout -b feature-branch-name
  3. Make your changes and commit them: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature-branch-name
  5. Submit a pull request

Future Improvements

  • An improved User Interface
  • Integrate AI-powered chatbot for 24/7 support and hotlines
  • Implement Jisti meeting for additional support group types and better anonymity in meetings
  • Add a reward system for consistent meeting attendance
  • Create wellness programs like breathing exercises, meditation and yoga
  • Implement comments in posts

License

This project is licensed under the Apache-2.0 license - see the LICENSE.md file for details.

Contact

For any questions or concerns, please open an issue on this repository or contact me:


Thank you for your interest in Mindful. Together, we can create a supportive and empowering community for those on their journey to recovery and mental wellness.