Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niloysikdar/sukoon
Realize, Calm, Heal. A platform to help people suffering from mental health issues and make them feel better through customized activities suggested according to their needs and also make them aware of their mental health condition.
https://github.com/niloysikdar/sukoon
hackathon reactjs
Last synced: 3 months ago
JSON representation
Realize, Calm, Heal. A platform to help people suffering from mental health issues and make them feel better through customized activities suggested according to their needs and also make them aware of their mental health condition.
- Host: GitHub
- URL: https://github.com/niloysikdar/sukoon
- Owner: niloysikdar
- License: gpl-3.0
- Created: 2021-05-28T15:51:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-01T16:39:30.000Z (over 3 years ago)
- Last Synced: 2023-03-10T23:45:21.652Z (almost 2 years ago)
- Topics: hackathon, reactjs
- Language: JavaScript
- Homepage: https://sukoon.vercel.app/
- Size: 1.75 MB
- Stars: 11
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Sukoon
Realize, Calm, Heal
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
### Built With
- [ReactJs](https://reactjs.org/)
- [Sawo](https://www.npmjs.com/package/sawo)
- [sweetalert](https://www.npmjs.com/package/sweetalert)
- [web-vital](https://www.npmjs.com/package/web-vitals)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
- npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/github_username/Sukoon.git
```
2. Install NPM packages
```sh
npm install
```
3. Create an account at [Sawo LABS](https://sawolabs.com/)
4. Create new project inside Developer Console
5. Enter the Host Name and enter `localhost` for Development Server
6. Create a file named `.env.local` inside the root folder of the project and enter
```
REACT_APP_API_SAWO="Your SAWO API Key"
```
7. Run the Local Server
```sh
npm start
```
## Roadmap
See the [open issues](https://github.com/niloysikdar/Sukoon/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the **GNU General Public License v3.0**. See [LICENSE](https://github.com/niloysikdar/Sukoon/blob/main/LICENSE) for more information.