README.md

A platform where NGOs find the heroes they need.

Be The Hero is an web/mobile application that connects NGOs with people interested in contributing to a noble cause.

Demo

Getting Started

Architecture

1. CORE: the server;
2. GUI: the web interface;
3. NGUI: the native interfaces for Android and iOS.

Prerequisites

• It is necessary to have Node.js installed on the machine;
• Also, it is necessary to have a package manager either NPM or Yarn;
• Finally, it is essential to have Expo installed globally on the machine.

1. Make a clone:

   git clone https://github.com/amintasvrp/be-the-hero.git

2. Running the Application:

  # Install, create the database
  # and launch the web application
  cd core
  npm install
  npx knex migrate:latest
  npm start

  # Start the API

  # Install and launch the web application
  cd gui
  npm install
  npm start

  # Install and launch the mobile application
  cd ngui
  npm install
  npm start

3. (OPTIONAL) Running the Application as Docker containers:

  # Build image and run API container
  cd core
  docker build -t core .
  docker run -d -it -p 3333:3333 --name core core

  # Build image and run web application container
  cd gui
  docker build -t gui .
  docker run -d -it -p 3000:3000 --name gui gui

  # and launch the web application
  cd ngui
  docker build -t ngui .
  docker run -d -it -p 3000:3000 --name ngui ngui

Running the tests

We can run the unit and integration tests using the command below:

npm run test

Contributing

Make a pull request and make clear what changes have been made and which bugs persist. Do not introduce bugs, be proactive!

Licenses

• MIT License - Ver detalhes