Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme update #109

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Readme update #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
03578db
updated readme and jest
cboydstun Mar 27, 2020
0afd7dc
added badges
cboydstun Mar 27, 2020
00fe734
netlify badge removed
cboydstun Mar 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,28 @@

https://luxapplication.com/auth

<a href="https://codeclimate.com/github/codeclimate/codeclimate/maintainability"><img src="https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability" /></a>

<a href="https://codeclimate.com/github/codeclimate/codeclimate/test_coverage"><img src="https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage" /></a>

| [Sanny Io](https://github.com/sanny-io) | [Lucas Baze](https://github.com/lucasbaze) | [Michael Demery](https://github.com/DemeryMA) | [Nick Interest](https://github.com/NicholasInterest1) | [William Vandolah](https://github.com/wvandolah) |
| :--------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: |
| [<img src="https://avatars0.githubusercontent.com/u/3054653?s=460&v=4" width = "200" />](https://github.com/sanny-io) | [<img src="https://avatars2.githubusercontent.com/u/16271037?s=460&v=4" width = "200" />](https://github.com/lucasbaze) | [<img src="https://avatars1.githubusercontent.com/u/52550247?s=460&v=4" width = "200" />](https://github.com/DemeryMA) | [<img src="https://avatars3.githubusercontent.com/u/51211229?s=460&v=4" width = "200" />](https://github.com/) | [<img src="https://avatars0.githubusercontent.com/u/17438091?s=460&v=4" width = "200" />](https://github.com/wvandolah) |
| [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/honda0306) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Mister-Corn) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/NandoTheessen) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/) |
| [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/sanny-sherief-85aa90120/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/lucas-bazemore) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/michael-demery/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/nicholas-interest-1a0957191/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/) |

| [Chris Boydstun](https://github.com/cboydstun) | [Avraham Candinov](https://github.com/avkan1087) | [Katrina Finney](https://github.com/KatrinaFinney) | [Nicole Adams](https://github.com/ndacode) | [Ian Vaughn](https://github.com/Yurimurda) |
| :--------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: |
| [<img src="https://avatars0.githubusercontent.com/u/52934303?s=460&v=4" width = "200" />](https://github.com/cboydstun) | [<img src="https://ca.slack-edge.com/T4JUEB3ME-UNM5RQ58E-9ae296eac1f6-512" width = "200" />](https://github.com/avkan1087) | [<img src="https://avatars3.githubusercontent.com/u/54245714?s=460&v=4" width = "200" />](https://github.com/KatrinaFinney) | [<img src="https://avatars2.githubusercontent.com/u/53717338?s=460&v=4" width = "200" />](https://github.com/ndacode) | [<img src="https://ca.slack-edge.com/T4JUEB3ME-ULP4KHE6M-59e8f1729c4e-512" width = "200" />](https://github.com/Yurimurda) |
| [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/cboydstun) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/avkan1087) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/KatrinaFinney) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/ndacode) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Yurimurda) |
| [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/chris-boydstun-4a990615/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/katrina-finney-a70b75191/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/nicoleadamsmedia/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/) |
| [Chris Boydstun](https://github.com/cboydstun) | [Avraham Candinov](https://github.com/avkan1087) | [Katrina Finney](https://github.com/KatrinaFinney) | [Nicole Adams](https://github.com/ndacode) | [Ian Vaughn](https://github.com/Yurimurda) |
| :--------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: |
| [<img src="https://avatars0.githubusercontent.com/u/52934303?s=460&v=4" width = "200" />](https://github.com/cboydstun) | [<img src="https://ca.slack-edge.com/T4JUEB3ME-UNM5RQ58E-9ae296eac1f6-512" width = "200" />](https://github.com/avkan1087) | [<img src="https://avatars3.githubusercontent.com/u/54245714?s=460&v=4" width = "200" />](https://github.com/KatrinaFinney) | [<img src="https://avatars2.githubusercontent.com/u/53717338?s=460&v=4" width = "200" />](https://github.com/ndacode) | [<img src="https://ca.slack-edge.com/T4JUEB3ME-ULP4KHE6M-59e8f1729c4e-512" width = "200" />](https://github.com/Yurimurda) |
| [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/cboydstun) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/avkan1087) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/KatrinaFinney) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/ndacode) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Yurimurda) |
| [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/chris-boydstun-4a990615/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](http://www.linkedin.com/in/avikan) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/katrina-finney-a70b75191/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/nicoleadamsmedia/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/ian-vaughn-80a6601a1/) |

<br>
<br>

![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg)
![React](https://img.shields.io/badge/react-v16.7.0--alpha.2-blue.svg)
![Typescript](https://img.shields.io/npm/types/typescript.svg?style=flat)
[![Netlify Status](https://api.netlify.com/api/v1/badges/b5c4db1c-b10d-42c3-b157-3746edd9e81d/deploy-status)](netlify link goes in these parenthesis)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://luxapplication.com/auth)

## Project Overview
Expand All @@ -43,27 +46,25 @@ The app will be a database that stores information regarding business operations
- Add and edit customers
- Assign jobs to teams

## Tech Stack
## Tech Stack Summary

### Front end built using:

#### React

- We learned it in Lambda School
- React is a library for building composable user interfaces. It encourages the creation of reusable UI components.

#### Reducers
#### Redux

- We learned it in Lambda School
- Redux is a predictable state container for JavaScript apps. It helps you write applications that behave consistently, run in different environments.

#### Formik

- We used formik for our forms because they come with .yup validation and we learned it in Lambda
- Formik is a small library that helps you with the 3 most annoying parts: getting values in and out of form state, validation and error messages, and handling form submission

#### Material UI

- Makes creating nice looking front-ends easier
- Simple API usage
- Comprehensive documentation
- React components for faster and easier web development. Build your own design system, or start with Material Design.

#### Front end deployed to `Zeit Now`

Expand Down Expand Up @@ -121,3 +122,9 @@ Remember that this project is licensed under the MIT license, and by submitting
### Attribution

These contribution guidelines have been adapted from [this good-Contributing.md-template](https://gist.github.com/PurpleBooth/b24679402957c63ec426).

### Known Defects

- Recurring only creates the same event weekly
- The login does work - you have to create a user via google and then re-load the page after you accept all the conditions during the user creation
- Google calendar is integrated into the app, but job events are passed down to teams and not team members
12 changes: 11 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,23 @@
"cypress": "^3.7.0",
"jest": "^24.9.0",
"react-test-renderer": "^16.12.0"

},
"scripts": {
"start": "react-scripts start",
"build": "npm run test && react-scripts build",
"test": "jest",
"eject": "react-scripts eject"
"eject": "react-scripts eject",
"coverage": "CI=true yarn test --coverage --watchAll=false || true"
},
"jest": {
"collectCoverageFrom": [
"**/*.{js,jsx}",
"!**/node_modules/**",
"!**/vendor/**",
"!**/__tests__/**"
]
},
"eslintConfig": {
"extends": "react-app"
},
Expand Down