Skip to content

Latest commit

 

History

History
130 lines (68 loc) · 3.74 KB

README.md

File metadata and controls

130 lines (68 loc) · 3.74 KB
Raw

Serenity Space

A website which will reduce your stress and depression. It will basically include AI driven support,community support and motivated resources in form of qoutes,reels and tedtalks.

Features

• Talk to Esmo, our AI chatbot.

• Get videos and and quotes which will hunt down your depression.

• Join our discord community and meet new people.

• Contact us for further help.

Requirements

Ensure you have the following installed on your system:

• Node.js (>=14.x)

• npm (>=6.x) or yarn (>=1.x)

Installation

Use these commands in your terminal

  1. Clone the repository: git clone https://github.com/yourusername/Serenityspace.git

  2. Navigate to the project directory: cd serenity-space

  3. Install the dependencies: npm install or yarn install

  4. Running the Project To start the development server, run: npm start or yarn start

This will run the app in development mode. Open http://localhost:3000 to view it in the browser.

⦿ Running Tests - To run tests, use the following command: npm test or yarn test

⦿ Linting - To lint the project files, use: npm run lint or yarn lint

⦿ To fix linting issues, use: npm run lint:fix or yarn lint:fix

Contributing

Contributions are always welcome!

We welcome contributions to Serenity Space! Please read the following guidelines to get started.

⦿ Code of Conduct

By participating in this project, you agree to abide by the Contributor Covenant Code of Conduct. Please read it to understand the expectations for all contributors.

⦿ How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub Issues. Include as much detail as possible to help us understand and resolve the issue quickly. You can use the following template:

• Describe the bug: A clear and concise description of what the bug is.

• To Reproduce: Steps to reproduce the behavior.

• Expected behavior: A clear and concise description of what you expected to happen.

• Screenshots: If applicable, add screenshots to help explain your problem.

• Additional context: Any other context about the problem

Suggesting Enhancements

We welcome suggestions for enhancements. To suggest an enhancement, please open an issue on GitHub Issues and use the following template:

• Describe the solution you'd like: A clear and concise description of what you want to happen.

• Describe alternatives you've considered: A clear and concise description of any alternative solutions or features you've considered.

• Additional context: Any other context or screenshots about the enhancement.

Your First Code Contribution

  1. Fork the repository.

  2. Create a new branch (git checkout -b feature/YourFeature).

  3. Make your changes.

  4. Commit your changes (git commit -am 'Add some feature').

  5. Push to the branch (git push origin feature/YourFeature).

  6. Create a new Pull Request.

Improving Documentation

If you see something that can be improved in the documentation, please submit a pull request. Documentation contributions are just as important as code contributions.

Style Guidelines

Commit Messages

• Use the present tense ("Add feature" not "Added feature").

• Use the imperative mood ("Move cursor to..." not "Moves cursor to...").

• Limit the first line to 72 characters or less.

• Reference issues and pull requests liberally.

Code Style

• Follow the coding style specified in the .eslintrc file.

• Use meaningful variable and function names.

• Write comments to explain complex logic and decisions.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

• React

• Redux

• styled-components

• Axios

• Contributor Covenant

Thank you for your interest in contributing to Serenity Space!