MindAnchor is a mental health companion app designed to help users manage their mental well-being through various techniques such as grounding exercises, cognitive restructuring, journaling, and crisis planning. Whether you're dealing with anxiety, stress, or just need a mental health check-in, MindAnchor provides tools and resources to help you stay grounded and focused.
- Reality Testing: Challenge and reshape your thoughts to promote a healthier mindset.
- Grounding Techniques: Simple exercises to help you stay connected to the present moment.
- Cognitive Restructuring: Reframe negative thoughts to reduce their impact.
- Safe Space: Create a virtual safe space for relaxation and mental clarity.
- Crisis Planning: Prepare in advance for potential mental health crises.
- Journaling: Record your thoughts, feelings, and experiences in a secure, personal space.
Before you begin, ensure you have met the following requirements:
- Python 3.7+ installed on your machine.
- Flask and Flask-Login for running the app.
- SQLite or another supported database system.
-
Clone the Repository
git clone https://github.com/username/MindAnchor.git cd MindAnchor
-
Create a Virtual Environment
python3 -m venv venv source venv/bin/activate # On Windows use `venv\Scripts ctivate`
-
Install Dependencies
pip install -r requirements.txt
-
Set Up the Database
flask db init flask db migrate -m "Initial migration." flask db upgrade
-
Run the Application
flask run
-
Access the Application
Open your browser and go to http://localhost:5000.
Once you have the application up and running, you can access the various features directly from the homepage:
- Reality Testing: Navigate to the "Reality Testing" section to challenge your thoughts.
- Grounding: Use grounding techniques to stay focused.
- Cognitive Restructuring: Access tools for reframing negative thoughts.
- Safe Space: Set up and customise your own virtual safe space.
- Crisis Planning: Prepare and store your crisis plan securely.
- Journal: Write and reflect in your personal journal.
MindAnchor supports a dark theme for those who prefer a low-light environment. To switch to dark mode, go to the "Settings" page and toggle the theme switch.
We welcome contributions from the community! To get started:
-
Fork the Repository
-
Create a Branch
git checkout -b feature/YourFeatureName
-
Commit Your Changes
git commit -m 'Add some feature'
-
Push to the Branch
git push origin feature/YourFeatureName
-
Open a Pull Request
Please make sure to follow the contribution guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.
- Flask - For providing the core framework for building the app.
- Flask-Login - For enabling secure user authentication.
- SQLite - For managing our database with ease.
- Bootstrap - For making the UI look great.
If you have any questions or feedback, feel free to open an issue or reach out to the project maintainers at [email protected].
Let's build a healthier mental space together with MindAnchor.