/bethehero-frontend

A React app for the Be The Hero project

Primary LanguageJavaScriptMIT LicenseMIT

Be The Hero - Frontend

Overview

The main objective of this project is to provide a way to help Non-Governmental Organisation find "Heroes" to help in their causes. This can be done by providing a web interface for the NGO to insert their needs and then a "Hero" can find these needs using a mobile app and get in touch with the organization. You will need the backend of this project and you can find it here.

Setting up

Requirements

  • Node.js
  • Npm
  • Yarn - This is optional but in this readme I'll be using it on some CLI commands, you can use npm if you want.

Dependencies

  • React.js - JavaScript library for building user interfaces
  • Axios - Promise based HTTP client
  • React Icons - Icons library
  • React Router Dom - DOM bindings for React Router.
  • Sweet alert - A beautiful, responsive, customizable, accessible (WAI-ARIA) replacement for JavaScript's popup boxes

Dev Dependencies

Installing

All you need to do is run yarn at the root of the project in order to install the dependencies. After installation, copy the .env.example and rename it to .env. Change the REACT_APP_URL to target your backend URL.

Starting

Just run yarn start.

License

This is a open-sourced software licensed under the MIT license.