Be The Hero is an application that has the purpose of helping Animal Welfare Non-governmental organizations (NGOs). In the mobile app people can see incidents in which a NGO needs financial help and get in touch with the NGO to provide help, NGOs can use the web version of the application to register new cases.
Use case example: Let's suppose a NGO who deals with animals on the street finds a dog with a broken paw. The NGO then takes the dog to it's place and register the incident to get external help from people willing to contribute with the costs.
How it works:
There is 2 versions of the application, each aimed at a different user, the web application and the mobile application, both feed from the server API available in the "backend" folder.The Web Application
The web application's code is avaible at the folder named "frontend", this application is to be used by NGOs to announce incidents.
The Mobile Application
The mobile application's code is available at the folder named "mobile", this application is to be used by anyone who is willing to help NGOs, the mobile app user can view all the cases registered by all the NGOs and choose one or more to step in and contact the organization to offer help.
Technologies
The webpage was built with ReactJS, the mobile app with React Native and the server with NodeJS. The database configured is SQLite and the application can be easily adapted to other relational databases, a SQL Query Builder named Knex is used to generate SQL queries.
How to execute the project
To run the project you'll need to have installed: Git, Node.js and Yarn.
Step 1 - Clone this repository
git clone https://github.com/higorhlg/BeTheHero
Step 2 - Start the server
First of all you should start the server, located in the "backend" folder, to do that you must run the following lines at your terminal:
# Navigate to backend folder
cd backend
# Install dependencies
yarn install
# Start Server
yarn start
Step 3 - Run the Web/Mobile Application
With the server up and running from the previous step made, you can now run the web or mobile application, respectively available in the frontend and mobile folders within the project, you can get them running using the same terminal commands described in the previous step:
# From the root folder of the project, go to the web or mobile application folder, for example, "frontend":
cd frontend
# Install dependencies
yarn install
# Run Application
yarn start
Both the web and mobile application will give you a URL that can be acessed through a browser to view the application, the mobile version URL will take you to a Expo page where you can choose to run the application via simulator or real smartphone.