| Eyve Geordan | J Tyler Sheppard | Ashwin Swamy |
|---|---|---|
 |
 |
 |
 |
|
|
Production Endpoint 👉 https://quake-ds-production.herokuapp.com/
Staging Endpoint 👉 https://quake-ds-staging.herokuapp.com/
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /lastQuake/SOURCE/MAGNITUDE |
all users | Returns the last quake over the given magnitude from the source |
| GET | /last/SOURCE/TIME/MAGNITUDE |
all users | Gets the quakes over the given timeframe |
| GET | /history/SOURCE/LAT,LON,DIST |
all users | Returns all quakes in a given area |
/lastQuake/SOURCE/MAGNITUDE- Returns the last quake over the given magnitude from the source
SOURCE: choice of 'USGS' or 'EMSC' depending on which datasource to pull from
MAGNITUDE: a number 0-11 (accepts floats and ints) defaults to 5.5
/last/SOURCE/TIME/MAGNITUDE- Gets the quakes over the given timeframe
SOURCE: choice of 'USGS' or 'EMSC' depending on which datasource to pull from
TIME: choice of 'hour', 'day', 'week' or 'month', returns quakes over the given time period
MAGNITUDE: a number 0-11 (accepts floats and ints) defaults to 5.5
/history/SOURCE/LAT,LON,DIST- Returns all quakes in a given area
SOURCE: choice of 'USGS' or 'EMSC' depending on which datasource to pull from
LAT and LON are the central latitude and longitude
DIST is the distance in miles from the center to search from
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.
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.
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.
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.
- 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.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.
See Front End Documentation for details on the front end of our project.