/quake-fe-pt9

With Epicentral you will get the latest updates on earthquakes happening around the world in real time; as well as up to date information on how to be prepared, and what to do in the event of an earthquake.

Primary LanguageJavaScriptMIT LicenseMIT

Maintainability Test Coverage

Epicentral

http://epicentral.info/

https://epicentralpt9.herokuapp.com/

Gary Porter Ryan West Juan Aleman Denise Chaloupka Joshua Daley

Project Overview

[Trello Board]

https://trello.com/b/Ja41ROfX/quake [Product Canvas]

https://www.notion.so/048af081122f4ab1bfc4b5203cb59bcf?v=0202f0145e3a494e8ce94dcb8e730bb8

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. With Epicentral you will be able to get the latest updates on earthquakes happening around the world in real time; as well as be able to get up to date information on how to be prepared, and what to do in the event of an earthquake.

Key Features

  • Search by City, Zipcode, State, Country
  • See earthquakes on the map
  • Earthquake preparedness information

Tech Stack

Front end framework goes here

React

  • point one Can fetch data from an API using axios
  • point two Allows users to Login and register easily
  • point three Can render map data
  • point four

Front end deployed to heroku

Back end built using:

nodeJs, postgresql

  • point one - can store user data
  • point two - can do many to many relationships in SQL
  • point three- can update user data

APIs

2️⃣ Authentication API here

https://epicentralpt9.herokuapp.com/api/users/login

3️⃣ Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following: 🚫These are just examples, replace them with the specifics for your app * REACT_APP_apiKey - this is your Google API key, which can be generated in the Google Cloud Console * REACT_APP_authDomain - when you set up your Firebase project, this information will be in the dashboard * REACT_APP_databaseURL - in the Firebase dashboard * REACT_APP_projectID - in the Firebase dashboard * REACT_APP_storageBucket - in the Firebase dashboard * REACT_APP_messagingSenderId - in the Firebase dashboard * REACT_APP_stripe_API - this is your public Stripe API key, generated in the Stripe dashboard * REACT_APP_backendURL - optional for your local development server * REACT_APP_clientid - this is the Stripe_connect clientID, generated in Stripe_connect settings * REACT_APP_stripe_plan - this is the ID for a second Stripe subscription plan, generated under Stripe products

5️⃣ Content Licenses

Image Filename Source / Creator License
doodles.png Nicole Bennett Creative Commons
rings.svg Sam Herbert MIT

4️⃣ Testing

Jest, supertest

Other Scripts

* typecheck - runs the TypeScript compiler
* 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](🚫_link to your backend readme here_) for details on the backend of our project.