Be The Hero

Be The Hero is an application that was developed during the week OmniStack 11 promoted by Rocketseat , with the objective of connecting people who are willing to help financially to NGOs (Non-governmental organizations) that care and treat animals. The Web system allows NGOs to register cases of animals that have a problem and need financial assistance to carry out the treatment. People who would like to help can use the mobile app to choose a case and contact the NGOs by e-mail or whatsapp.

---

Features

This app features all the latest tools and practices in web and mobile development!

• Back-end
  • NodeJS — a JavaScript runtime server environment
  • express — a web application framework
  • nodemon — a utility that will monitor for any changes in your source and automatically restart your server
  • knex — a SQL query builder for SQL databases
  • sqlite3 — a asynchronous, non-blocking SQLite3 bindings
  • celebrate — an express middleware function that wraps the Joi validation library
  • cors — a package for providing a Connect/Express middleware to difine who can access the API
  • cross-env — set and use environment variables
  • jest — a JavaScript Testing Framework
  • supertest — provide a high-level abstraction for testing HTTP
• Front-end
  • ReactJS — a JavaScript library for building user web interfaces
  • react-dom — the entry point to the DOM and server renderers for React
  • react-router-dom — DOM bindings for React Router
  • react-scripts — includes scripts and configuration
  • react-icons — popular icons
  • react-toastify — allow you to add notification to your app
  • axios — promise based HTTP client for the browser and node.js
  • styled-components — utilising tagged template literals, allows write actual CSS code to style components
• Mobile
  • React Native — a lib that provides a way to create native apps for Android and iOS
  • react-navigation — navigation solution based on JavaScript
  • expo — a set of tools and services built around React Native
  • expo-constants — provides system information
  • expo-mail-composer — provides an API to compose mails using OS specific UI
  • axios — promise based HTTP client for the browser and node.js
  • react-icons — popular icons
  • intl — used for formatting strings, numbers, and date and time
• Database
  • SQLite — A cross-platform document-oriented relational database management system

Getting started

1. Clone this repo using git clone [email protected]:jairokoning/be-the-hero.git
2. Move yourself to the appropriate back-end directory: cd be-the-hero/backend and run npm-install
3. Move yourself to the appropriate front-end directory: cd be-the-hero/frontend and run npm-install
4. Move yourself to the appropriate mobile directory: cd be-the-hero/mobile and run npm-install

Getting started with the backend server

1. Move yourself to the backend folder: cd backend
2. Run npm start to start the server

Getting started with the frontend app

1. Move yourself to the front-end folder: cd frontend
2. Run npm start to start the web application

Getting started with the mobile app

1. Change the baseURL in scr/services/api.js informing your IP
2. Move yourself to the mobile folder: cd mobile
3. Run npm start and use your phone's Expo app to scan the bar-code

License

This project is licensed under the MIT License - see the LICENSE page for details.