Skip to content

Latest commit

 

History

History
executable file
·
83 lines (62 loc) · 4.44 KB

README.md

File metadata and controls

executable file
·
83 lines (62 loc) · 4.44 KB
Raw

☑️ QuestBook 🤗

✨ Welcome to QuestBook ✨
This project is target to a very regular problem which grew largely and came to notice during covid situations. People are too bored and struggling with severe mental issues. Our application tries to overcome this boredom and mental health issue with the help of some easy and fun tasks. Helping them contribute to social issues during such hard times.


❤️ Note for new Contributors : ❤️

Thank you very much for considering this project. Make sure you read Code of Conduct and Contribution Guidelines before making contributions. Feel free to raise an issue and after getting assigned to it, you are all set to work on it.

📌 About the project :

This project was intentionally built for the DataStax's Build a modern data app Hackathon. This project is made for solving social issues while having fun. As there is nothing better than helping each other in this covid times.

📌 Briefing of the project :

We have been into these tough situations for now over 2 years. People are restricted to stay at home and socialize less. There have been many cases reported where it is seen that people are suffering through severe mental health issues like stress, anxiety, depressive symptoms, insomnia, denial, anger and fear. People were not ready for such a sudden change in their routine and lifestyle. As the world has changed and many conventional entertainment sources are no more helpful. Here comes our application. Our application is specially targeted to help people overcome the above stated problems. So what does the app do? The app is like a social platform where people can join and the will get few weekly/monthly tasks to be done. Tasks would look something like Planting tree/watering tree/Donating food/Donating blood/Taking vaccination etc. In this way people can help out other people in socity and get entertained as well. After completion of every task the user will receive some points which they can redeem in many ways as they want or if they want they can donate the points to the application where we (team) can convert these points into monitory things (food, clothes) etc or donate it to a NGO. This application is totally target for helping society and it's issues dureing the covid time :)

📌 Screenshots

🚩 Working app:

📌 Technologies used

  • ReactJS (Frontend)
  • NodeJS/ExpressJS (Backend)
  • DataStax AstraDB (DataBase)

📌 Contribution :

Contribution to this repos are always welcome. You can always upgrade the UI, or fix any bug predefined in the issue section.

For new contibution or feature :

  1. Open a new issue describing the feature.
  2. Add feature tag to this issue.
  3. Get acceptance from the code maintainers.
  4. Enjoy adding the feature

📌 Steps to contibute (Back-End):

  1. Fork the project: Fork the project from https://github.com/kaiwalyakoparkar/questbook-backend

  2. Cloning the project :

git clone https://github.com/<your-user-name>/questbook-backend.git
  1. Run npm i
  2. Create .env from .env-sample
  3. Create DataBase on DataStax Astra
  4. Go to Management and add a Administrator user
  5. Now copy the credentials and add it to the .env file you just created
  6. Start the server and check out the endpoints
  7. Do the specified changes in the code
  8. Test the code by testing in on server/api
  9. Make a PR to this repo
  10. Grab a coffee/Tea until furtur disucssion with the maintainers

📌 Steps to contibute (Front-End):

Refer Front-End Repo

Team Members & Contributors

All the below mentioned are prominent element of this project and without them it wouldn't be possible.