Skip to content

ribeiromatheus/find-a-hero

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

130 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub language count Repository size GitHub last commit Packagist

Help NGOs (Non-Governmental Organization) you are interested in.

Find a hero is a web app and mobile app that you can register your NGO and receive donations from people.

Technologies

  • Node.js
  • ReactJS
  • React Native
  • Expo

Requirements

About Web app

Register

This is the Register page; fill in the fields to get your ID.

image

Logon

This is the Logon page; enter your ID to get full access to the application.

image

Incident Registration

This is the Incident Registration page; fill in the fields to register a new incident.

image

Profile

This is the Profile page; here is where you can check incidents out.

image

About Mobile app

Incidents

This is the Incidents page; here is where you can check incidents out.

incidents

Detail

This is the Detail page; here you can check details out about an incident. And if you are interested in it you can send a whatsapp message or email to help the NGO.

detail

Useful libs / modules

Backend

  • express - for server creation.
  • Knex.js - SQL query builder for Javascript.
  • cors - to allow the API to be accessible to the web application.

Web

Mobile

  • @react-navigation - create routes and handle it.
  • @react-navigation/stack - a way for the app to transition between screens.
  • axios - make HTTP requests to nodejs API.
  • expo-mail-composer - allows us to compose and send email quickly and easily using the OS UI.
  • expo-constants - provides system information that remains constant throughout the lifetime of your app's install.
  • intl - provides currency formatting.
  • @expo/vector-icons (installed by default) - to add icons.

Get started

  1. At first, clone the repo by running git clone https://github.com/ribeiromatheus/find-a-hero.git or hub clone ribeiromatheus/find-a-hero - if you have hub installed on your machine - on your favorite terminal.
  2. After cloning run yarn or npm install on backend, web and mobile folder.
  3. Next, go to mobile folder and create a folder in the src directory named credentials, then create a json file named baseUrl so you can add your ip address followed by server port or your server url.
{
    "ip": "http://<ip goes here>:<port goes here>"
}

License

This project is under the MIT license. See the LICENSE file for more details.

Releases

No releases published

Packages

 
 
 

Contributors