/quake-fe

Primary LanguageJavaScriptMIT LicenseMIT

MIT React Typescript code style: prettier Maintainability Test Coverage

FaultLine

You can find the deployed project Here.

Contributors

Nicole White Nicole LinkedIn logo Pete James Pete LinkedIn logo Cesar Hernandez Cesar LinkedIn logo Ken Diehl Ken LinkedIn logo
Ken Pete Pete
Eddie Jimenez github icon Linkedin icon Jeff Breig github icon linkedin icon Laura Suyasa linkedin icon Jeremy Green linkedin icon
Eddie Jeff Laura Jeremy

Project Overview

FaultLine is an application built in React.js that is focused on bringing the latest earthquake information from around the world, right to your fingertips.

trello icon Trello Board

notion icon Product Canvas

figma icon UX Design files

Key Features

  • Get the latest earthquake info immediately, from all over the world
  • Interactive map to visualize quake activity in a geographical context
  • Extensive search filters to find the exact data you need
  • Easy to use and built with accessability in mind
  • Built mobile first so we are always in your pocket

Tech Stack

Front end built using:

🚫 Why did you choose this framework?

  • point one
  • point two
  • point three
  • point four

🚫 List the rest of the front end features and libraries in the same format as the framework above

Front end deployed using Heroku

Back end built using:

  • point one
  • point two
  • point three

🚫 List the rest of the back end end features and libraries in the same format as the framework above

APIs Used

  • The USGS Earthquake Catalog API allows for custom searches for earthquake information using a variety of parameters.
  • The Mapbox web services APIs allow you to programmatically access Mapbox tools and services. You can use these APIs to retrieve information about your account, upload and change resources, use core Mapbox tools, and more.
  • The Mapbox web services APIs allow you to programmatically access Mapbox tools and services. You can use these APIs to retrieve information about your account, upload and change resources, use core Mapbox tools, and more.

🚫Replace text below with a description of the API

When you do it your way you can go anywhere you choose. Let your heart take you to wherever you want to be. If I paint something, I don't want to have to explain what it is. A tree needs to be your friend if you're going to paint him. That's a son of a gun of a cloud. Even the worst thing we can do here is good.

️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:

* REACT_APP_MAP_API_TOKEN - MapBox Maps Service API Token.
  - This is needed to enable access to MapBox's geocoding and map rendering service.
  - This token can be found in the MapBox Account card on the trello board.
  
* REACT_APP_MAP_STYLE_TOKEN - MapBox Map Style Token.
  - This is needed to style the 2D map provided through MapBox.
  - This token can be found in the MapBox Account card on the trello board.

️Content Licenses

🚫For all content - images, icons, etc, use this table to document permission of use. Remove the two placeholders and add you content to this table

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

Testing

🚫Document what you used for testing and why

Installation Instructions

DO NOT use NPM to install packages for this project. If a package-lock.json file is in your local directory, delete it before pushing any code.

  1. Clone this repo from GitHub git clone https://github.com/Lambda-School-Labs/quake-fe.git

  2. Run yarn to begin installation of packages. yarn

  3. Once packages are installed, start the development server and get coding yarn start

Other Scripts

* build - creates a build of the application
* start - starts the development server
* test - runs tests in **tests** directory 
* coverage - runs all tests and gives a detailed report of test coverage
* 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.