mastansayyad/emowell

Emowell - Enhancing Emotional Wellbeing

Check the Website here.

TABLE OF CONTENTS

• About our project
• Tech Stack Used
• Website Overview
• Key Features ✨
• Components of Website
• 🔖Steps to Contribute ✅
• 🔑Guidelines✨

About our project

Emowell is a web application aimed at enhancing emotional wellbeing by providing various features and resources to help individuals manage their mental health effectively. The application includes a chatbot for seeking advice and support, a collection of games and activities for relaxation, a reading area with resources related to mental health, and a community forum for discussions and support.

Tech Stack Used

Website Overview

Welcome to Emowell, your comprehensive hub for enhancing emotional wellbeing and effectively managing mental health. Our web application offers a dynamic range of features, including a supportive chatbot for personalized advice, a diverse array of relaxation games and activities, an informative reading area packed with mental health resources, and a welcoming community forum for discussions and mutual support. Join us on this holistic journey towards greater emotional resilience and fulfillment.

Key Features ✨

1. Chatbot

   • Engage in conversations about mental health.
   • Seek advice and support for managing emotions and coping with challenges.
   • Access games and activities to improve mood.

2. Games Section

   • Explore a variety of games designed to promote relaxation and reduce stress.
   • Choose from different categories based on preferences.

3. Reading Area

   • Access a curated collection of resources related to mental health and emotional wellbeing.
   • Find articles, guides, and tips for maintaining good mental health.

4. Community Forum

   • Participate in discussions with peers and professionals about mental health topics.
   • Share experiences, ask questions, and provide support to others in the community.

🔖Steps to Contribute ✅

• Contribution is the best way to support and get involved in the community!
• Contributions to EmoWell Please check our CONTRIBUTING.md
  

Get started on the local machine

Step 1:

Fork the repository.

Step 2:

Clone the forked repository on your local machine.

git clone https://github.com/<your_github_username>/EmoWell.git

Step 3:

Open command prompt/Terminal.

Step 4:

Shoot up a terminal and run:

cd EmoWell

For installing all the required dependencies and packages

npm install

This will open up the website on localhost. You can begin working. The changes will be reflected here. To access it navigate to http://localhost:5173/ in your browser

npm run dev

If you have any ideas or questions 🤷

• Raise an issue
• Feature request
• Code submission

✨🔨Note:

• Do not edit/delete someone else's script in this repository. You can only insert new files/folders into this repository.

• Give a meaningful name to whatever file or folder you are adding, changing, etc.

🔑Guidelines✨

1. Welcome to this repository, if you are here as an open-source program participant/contributor.
2. Participants/contributors have to comment on issues they would like to work on, and mentors or the PA will assign you.
3. Issues will be assigned on a first-come, first-serve basis.
4. Participants/contributors can also open their issues using issue_template, but it needs to be verified and labeled by a mentor or PA. Please discuss this with the team once before opening your issues. We respect all your contributions, whether it is an Issue or a Pull Request.
5. When you raise an issue, make sure you get it assigned to you before you start working on that project.
6. Each participant/contributor will be assigned 1 issue (max) at a time to work.
7. Participants are expected to follow project guidelines and coding style . Structured code is one of our top priorities.
8. Try to explain your approach to solving any issue in the comments. This will increase the chances of you being assigned.
9. Don't create issues that are already listed.
10. Please don't pick up an issue already assigned to someone else. Work on the issues after it gets assigned to you.
11. Make sure you discuss issues before working on the issue.
12. Pull requests will be merged after being reviewed by a mentor or PA.
13. It might take a day or two to review your pull request. Please have patience and be nice.
14. Always create a pull request from a branch other than main.
15. Participants/contributors have to complete issues before they decided Deadline. If you fail to make a PR within the deadline, then the issue will be assigned to another person in the queue.
16. While making PRs, don't forget to add a description of your work.
17. Include the issue number (Fixes: issue number) in your commit message while creating a pull request.
18. Make sure your solution to any issue is better in terms of performance and other parameters in comparison to the previous work.
19. We all are here to learn. You are allowed to make mistakes. That's how you learn, right?

License 🪪

MIT license

Thanks to all the Contributors ❤️