Skip to content

avkan1087/we-got-this-fe

 
 

Repository files navigation

We Got This!!

https://luxapplication.com/auth

Sanny Io Lucas Baze Michael Demery Nick Interest William Vandolah
Chris Boydstun Avraham Candinov Katrina Finney Nicole Adams Ian Vaughn


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

Project Overview

Trello Board

Product Canvas

UX Design files

The app will be a database that stores information regarding business operations and will allow managers and technicians to store records about their work.

Key Features

  • Scheduling jobs for customers
  • Integrating with Google Calendar
  • View customers information
  • Filter jobs by zip code
  • Uploading checklist/pictures related to job
  • Add and edit customers
  • Assign jobs to teams

Tech Stack

Front end built using:

React

  • We learned it in Lambda School

Reducers

  • We learned it in Lambda School

Formik

  • We used formik for our forms because they come with .yup validation and we learned it in Lambda

Material UI

  • Makes creating nice looking front-ends easier
  • Simple API usage
  • Comprehensive documentation

Front end deployed to Zeit Now

APIs

Firebase

Firebase is a platform to assist in the rapid development of websites that don't need to worry about a backend. It is for this reason we chose to use this API.

Testing

Cypress was used for testing because it has a unique suite that lets you visualize tests and their results.

Installation Instructions

Execute yarn in the project folder.

Other Scripts

yarn run cypress open opens the Cypress testing suite.

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.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.1%
  • Other 0.9%