Wildfire Watch

You can find the deployed project at thewildfirewatchapp.com.

Contributors

Alexander Stillo	Dora Belme	Neha Patel	Penny Tague	Lily Zhou

Adam McKenney	Chance Dare	Eric Wuerfel	Gabby LoScalzo	Lloyd Edwards

Project Overview

Wildfire Watch is designed to help people understand when they are in danger of being struck by a wildfire, and hopefully give them time to get out.

Trello Boards

Product Canvas

UX Design files: map & profile

Key Features

Demo view & search autocomplete

Signed out users can demo part of the the application and see a clear "Sign Up" call-to-action. Autocomplete of searched addresses are shown in a dropdown using geocoder autocomplete. Users are directed to a login modal upon attempting to save a location.

Login, Registration, and Change Password Modals

Use cases for incorrect inputs based on Firebase or backend server responses are indicated to the user. User authentication is handled using Firebase.

Saved locations and fire markers

Saved locations are indicated by a green marker and fires that are within a radius (in miles) of the address are highlighted with exclamation markers. Fire distances are calculated via the haversine formula (i.e. distance between two latitude/longitude points on a sphere).

User Profile

Users may edit their email address or phone number, and toggle on the options of receiving SMS alerts for saved locations.

SMS notification alerts via Twilio API

Users can subscribe to SMS alerts. These alerts tell them the name of the closest fire and how many fires are within a given distance (user defined) from the saved locations. We send these alerts using the Twilio API. Notifications are re-sent every 6 hours using CRON scheduler.

Push notification alerts

Users can subscribe to in-browser push notifications. Like SMS alerts, they receive personalized messages based on the locations they save and the distance they set for these alerts.

Add Location Form

Users can delete locations through both the map and locations list. They can add new locations through a form and are prevented from adding duplicate locations.

Responsive Mobile View

The App is fully responsive for tablet and mobile devices.

Tech Stack

Front end built using:

• ReactJS (Hooks)
• Node-Sass
• Axios
• MapBox
  • React-Map-GL: gives the application the abilty to convert addresses to latitude/longitude for our backend applications
  • React Mapbox Geocode

Backend built using:

• NodeJS
• ExpressJS
• Twilio
• Firebase: email and password based authentication
• KnexJS: management of database structure
• JWT: handling authorizations
• PostgreSQL

Environment Variables

REACT_APP_VAPID_PUBLIC - for push notifications
REACT_APP_MAPBOX_TOKEN - to get your own Mapbox token, go to https://docs.mapbox.com/api/#access-tokens-and-token-scopes.
REACT_APP_ENV - set to the url of your deployed Heroku backend for staging/production, default to "http://localhost:5000/api/" for local development

Update the fire.js file with your own Firebase information.

Testing

The following libraries are used for testing:

• testing-library/react
• cypress

Installation Instructions

1. Fork this repository.
2. Clone this repository.
3. Navigate into the 'fireflight' directory.
4. Use npm install, yarn install, or pnpm install.
5. Checkout your own branch and start hacking.

Other Scripts

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory
* eject - copy the configuration files and dependencies into the project so you have full control over them

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.