Skip to content

Splashpool/splashpool.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

https://splashpool.github.io

Oasis App Front End

Introduction

According to WaterAid, one in ten people in the world don't have access to clean water. With droughts and flooding becoming more common due to climate change, this figure is likely to increase.

The Oasis application would allow regional users to locate clean water and toilet facilities in their vicinity and report any problems they have encountered. For organisations, managing such facilities, the app can provide a way to monitor their status and receive notifications from the users.

In this repository, you can find the code for the front end of the Oasis application. It was written by Team Splashpool during the Tech Returners Your Return to Tech programme in London Sept-Oct 2020 inclusive. It is a React-redux based front end application based on serverless framework running lambda functions at the backend, connected to an AWS RDS (MySQL) database. The code base for the back end application can be found here.

You can access the application here.

Preview

alt text

Technology used

  • ReactJS
  • Redux
  • JavaScript ES6+
  • HTML
  • CSS
  • Material UI
  • Axios
  • Mapbox API
  • Google Geocode API
  • CircleCI

The Mapbox web services APIs allow you to programmatically access Mapbox tools and services. For this app the Maps and Search APIs were used. For more information and the documentation on how to make changes follow the link here.


Instructions

This codebase makes use of npm for dependencies and build. As such assumes that npm has been installed and configured ready to use.

In order to install all the depencencies, first run

npm install

To run the app in development mode, type

npm start

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.