Project   |    Techs   |    Extras   |    Installation   |    Test   |    To Do   |    Contributing   |    License

Project 💻

Be The Hero connects people who want to help Non Governmental Organizations (NGO). At the platform NGOs can create incidents which they need a hero to help. The heroes can search through all the incidents created and choose which one they want to help and contact the NGO.

It was a project made on Rocketseat's #11 OmniStack Week, with a few changes.

Techs 🚀

• Node.js;
• ReactJS;
• React Native.

Extras 🎰

• Email integration (account verification, reset password etc);
• JWT authentication;
• Frontend x Backend Validation.

Installation 🔧

You can install the application server and client using, from the root folder, the following command:

yarn installapp

If you wish to install the mobile version, from the root folder run the following command:

yarn installmobile

Or, if you use Android, download and install the .apk on your phone

Test ✔️

To start the application server on your local machine, from the root folder, just run:

yarn start

Note: you need to create a .env file on the server directory based on the example file. You can read the documentation of the APIs and test them here.

To start the application client (frontend), from the root folder, just run:

yarn startclient

Remember to change the client and mobile api's baseURL to your local server adress (which is set to http://localhost:8080/ at server/index.js) or to your production server.

To start the mobile application client you need to install expo on your local machine then, from the root folder, just run:

yarn startmobile

To do 📰

• Profile page for NGO insert and detail more about them;
• Create more contact options;
• Filters so that NGO and heroes can search through incidents more efficiently;
• Mark the incidents that have been already solved;
• Interface for the NGOs on the mobile version, in the moment the mobile app only lists all the incidents created and allows you to contact the NGO responsible.

Contributing 🤔

Please read CONTRIBUTING for details on code of conduct, and the process for submitting pull requests to the project.

License 📝

• MIT license
• Copyright 2020 © Leonardo Ronne.