Team-078-EmergencyApp

barebones setup for JavaScript / Node projects replace this with a one-liner phrase describing this project or app

About

This app, built to manage emergencies, connects users - victim or passersby - with first responders. The app is designed to help alert, report, inform, monitor and by extension, avoid occurrences of road accidents. The app is user friendly, easy to use and accommodates users with little or no tech experience.

Why

This App provides a solution that addresses the Sustainable Development Goal (SDG) 3: Ensure healthy lives and promote well-being for all at all ages, with focus on Target 3.6: By 2020, halve the number of global deaths and injuries from road traffic accidents.

Usage

To make use of the emergencey app, please download via:

Setup

Install npm or yarn if you dont have any of them already installed. We recommend Yarn though.

After clonning the repo to your local machine and moving into the cloned folder, Run yarn install to get started by installing dependencies.

src/index.js is the entry to the project and source code should go into the src folder.

All tests should be written in the `tests' folder. There's a sample in there.

This starter uses Parcel as the bundler. It is much simpler that WebPack and the others.

Hints

• Run npm install or yarn install to get started. We'll assume you are using Yarn.
• Install additional dependencies: yarn add <dependency-name> [-D]
• Run tests: yarn test
• Run tests with test coverage info: yarn test:cover
• Check the codebase for proper syntax and formatting compliance: yarn lint
• Run your app in local dev mode: yarn start. This puts the bundled app in a dist folder, set up a local web server at localhost:1234, and continues to watch for your code changes which it syncs with the local server. This means if you loaded the app in a browser, it will auto-refresh as you code along. Feel free to use whatever bundler best meets your needs. Parcel was only added as a sample and for those looking for a simple but effective solution to the hassle of bundlers.

Authors

@Oluwatobi Fatumo @Kenenna Onwuagba @Dbinutu @Adedayo Anthony @Bonvic Bundi @Grace-Amarahu @Melvin Kosisochukwu

Contributing

If this project sounds interesting to you and you'd like to contribute, thank you! First, you can send a mail to [email protected] to indicate your interest, why you'd like to support and what forms of support you can bring to the table, but here are areas we think we'd need the most help in this project :

1. area one (e.g this app is about human trafficking and you need feedback on your roadmap and feature list from the private sector / NGOs)
2. area two (e.g you want people to opt-in and try using your staging app at staging.project-name.com and report any bugs via a form)
3. area three (e.g here is the zoom link to our end-of sprint webinar, join and provide feedback as a stakeholder if you can)

LICENSE

MIT