DentonWarnock / wowo-fe

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ExpressWash.us

Maintainability Test Coverage

You can find the deployed project at https://www.expresswash.us/.

Contributors

Matt Thomas DaQuan Freeman Ryan Ansberry Melki Alarcon Cale Haug Sam Malanchuk

WEBPT9 team

Chris Adams Jeffrey Marte Tommy Kindle Denton Warnock Adric Burks

Project Overview

Trello Board

Product Canvas

Key Features

  • Login/Register (client, washer)
  • Same day or schedule a car wash up to one week in advance
  • Allow the user to specify the vehicle make, model, color, year, license plate, size, type, and upload a photo.
  • Users can easily select their current location, home address, or pick a new address for their car wash.
  • Washers can set their own rates and choose from nearby jobs
  • Job completion notification / Leave a rating for a washer
  • Pay for a wash (with stripe checkout)
  • Email / in app Receipt of payment for client
  • Map that shows the washer's location and nearby available jobs
  • Photos upload from washer for pre/post wash

Tech Stack

ExpressWash.us is a web based app built on a PostgreSQL Database, and a Node Express back-end. The front-end is built on React and uses Redux for state managment. The app is designed with a Mobile first development approach and puts user accessibility features as a top priority.

Front end built using

React, Redux, Mapbox, Stripe-Checkout, JWTs, Bootstrap, Styled-Components

Front end deployed to Expresswash.us

Back end built using

Node.js, Express, Postgres, Knex, BCrypt, JWT, Multer S3.

APIs

Payment API

Stripe Checkout

Misc API

Mapbox-GL, Google Maps

Environment Variables - Front End

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_STRIPE_KEY - this is your public Stripe API key, generated in the Stripe dashboard

Content Licenses

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

Testing

React-testing-library (RTL) - built in tool for testing React

Installation Instructions

* clone the repo to your local machine
* cd into your newly created directory
* run `npm install`
* run `npm start`

Other Scripts

* build - creates a build of the application
* start - starts the production server after a build is created. Open (http://localhost:3000) to view it in the browser.
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them
* eject - command will remove the single build dependency from your project.
* coverage - runs test coverage percentages

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.

About

License:MIT License


Languages

Language:JavaScript 97.9%Language:CSS 1.1%Language:HTML 1.0%