/rv-nav-fe

Primary LanguageJavaScriptMIT LicenseMIT

RV Navigator

You can find the deployed project at https://www.rvnav.com/ .

Contributors

Sean Pheneger Latwan Wesley Blake Mitchell Jason Belgard Kevin Sims
Mitchell Robles Stacy Williams Dakota Hoskins Matthew Thatcher Noor Al Darraji
Jerry Osorio Olga Cortez Vanessa Flores Danny Manzietti Joshua Holtsclaw
Dale Pancho Jacob Connerly Joshua Sharp Labs 21 Labs 21

MIT React Typescript [Netlify Status](netlify link goes in these parenthesis) code style: prettier

Project Overview

Trello Board

Product Canvas

UX Design files

Traveling safely for RVers is difficult. RV Life will get you to where you need to go safely and with no hassle.

Using several available data sources integrated into a map thats designed for RV travel, we supply you with the route you need. Trust RV Life to safely get you there.

Key Features

  • Avoid Low/Dangerous areas
  • Routes specific to your RV
  • Points of interest

Tech Stack

Front end built using:

React.js

  • most flexible Javascript framework

Redux

  • A predictable state container for Javascript Apps

Class Components

  • Used to manage state within React elements

Front end deployed to Heroku

Back end built using:

Node.js

  • Universal
  • Easy to setup
  • Easy to manage

Express

  • a minimal and flexible Node.js web application framework that provides a robust set of features to develop web and mobile applications

JSON Web Tokens

  • An open, industry standard RFC 7519 method for representing claims securely between two parties.

APIs

Arcgis Api

Used to plot polyline routing, includes avoidance points.

Used for the Map rendered to the screen, as well as the users Geolocation.

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_ARC_KEY - this key enables the use of the Arcgis Api
*  REACT_APP_FIREBASE_API_KEY - this key enables us to use Firebase API
*  REACT_APP_FIREBASE_AUTH_DOMAIN - this key enables us to use Firebase Auth Domain

Testing

Cypress.io, very easy way to test app functionality.

Installation Instructions

Run yarn install or NPM install to download all of the needed dependencies.

Google Analytics tracking

https://analytics.google.com/analytics/web/#/report-home/a146265608w208349968p200888715

Sign in using RV Nav gmail credentials. Global site tag is located in index.html on lines 44-56.

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
*cypress - opens cypress gui and begins testing

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.