WellQuest

Welcome to WellQuest Club, a transformative project dedicated to supporting individuals on their journey to recovery from drug addiction. Our platform serves as a beacon of hope, providing personalized support, resources, and a supportive community to empower lives beyond addiction.

Table of Contents

• Getting Started
• Contributing
• Code of Conduct
• License

1. Fork the Repository:

   • Fork the WellQuest Club repository to your GitHub account.

2. Clone the Repository:

   • Clone the forked repository to your local machine.

     git clone https://github.com/Samarth277/hackathon_project.git
     cd WellQuest-Club

3. Install Dependencies:

   • Install project dependencies using npm.

     npm install

4. Create a Branch:

   • Create a new branch for your contribution.

     git checkout -b feature/your-feature-name

5. Make Changes:

   • Implement your changes or additions to the project.

6. Run Tests:

   • Ensure that your changes do not break existing functionality.

     npm test

7. Commit Changes:

   • Commit your changes with a descriptive commit message.

     git add .
     git commit -m "Add your descriptive commit message here"

8. Push Changes:

   • Push your changes to your forked repository.

     git push origin feature/your-feature-name

9. Opening a Pull Request (PR):

   • Open a Pull Request on the main repository. Provide a clear title and description for your changes.

[Instructions on setting up the project, dependencies, and how to run it]

Contributing

Open for All Contributors!

We welcome contributions from everyone. Please take a moment to review the Contributing Guidelines for detailed information on how to get started with contributing to this project.

How Can You Contribute?

1. Reporting Bugs:

   • If you come across a bug or unexpected behavior, please open an issue with a detailed description.

2. Suggesting Enhancements:

   • Have an idea to improve the project? Feel free to open an issue to discuss and get feedback.

3. Contributing Code:

   • Found a bug and want to fix it? Have a new feature to add? Follow the contribution guidelines to submit a pull request.

4. Documentation:

   • Documentation is crucial. If you find areas where it can be improved or expanded, your contributions are highly appreciated.

How to Contribute

1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine.
3. Create a new branch for your contribution.
4. Make your changes and commit them.
5. Push the changes to your fork and submit a pull request.

WellQuest Club - Contributor Code of Conduct

Our Pledge

In the spirit of fostering a positive and collaborative environment, we, as contributors and maintainers of WellQuest Club, pledge to treat all individuals with respect, kindness, and empathy.

Our Standards

• Be inclusive and welcoming of diverse perspectives and experiences.
• Show empathy towards fellow contributors.
• Refrain from any form of harassment or offensive behavior.
• Value constructive criticism and be open to learning from others.

Our Responsibilities

Project maintainers are committed to maintaining a welcoming space and will address issues promptly and fairly. Instances of unacceptable behavior may result in the removal of specific contributions or contributors.

Enforcement

Violations of this Code of Conduct can be reported by contacting the project team at [stackdevsamarth@programmer.net]. All reports will be reviewed and will be met with a prompt and appropriate response.

Attribution

This Contributor Code of Conduct is inspired by the Contributor Covenant, version 2.0.

Resources Used in This Project

Character Figures: https://bigheads.io/
Fonts: https://fontsource.org/
Svg Icons From: https://icons8.com & https://freesvg.org/

External Libraries used in this project:

styled-components
GSAP
type-writer effect
react-confetti
react-use