Uriel Contreras - Deliverable #1

.commitlintrc

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

.env

@@ -0,0 +1 @@
+FAST_REFRESH=false

.env.sample

@@ -0,0 +1 @@
+FAST_REFRESH=false

.eslintrc

@@ -1,6 +1,9 @@
 {
-  "extends": ["react-app", "airbnb", "prettier", "prettier/react"],
-  "plugins": ["prettier"],
+  "extends": ["react-app", "react-app/jest", "airbnb", "prettier", "prettier/react", "plugin:compat/recommended", "plugin:security/recommended"],
+  "plugins": ["prettier", "compat", "security"],
+  "env": {
+    "browser": true
+  },
   "rules": {
     "prettier/prettier": "error",
     "react/jsx-filename-extension": "error",

.gitignore

@@ -1,5 +1,8 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
+# settings
+.vscode/
+
 # dependencies
 /node_modules
 /.pnp

.huskyrc

@@ -0,0 +1,7 @@
+{
+  "hooks": {
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+    "pre-commit": "lint-staged",
+    "pre-push": "npm run lint"
+  }
+}

.lintstagedrc

@@ -0,0 +1,7 @@
+{
+  "*.{js,jsx,css,json}": [
+    "npm run lint:fix",
+    "npm run test:coverage",
+    "pretty-quick --staged"
+  ]
+}

.prettierrc

@@ -2,8 +2,8 @@
   "trailingComma": "es5",
   "tabWidth": 2,
   "printWidth": 90,
-  "semi": true,
+  "semi": false,
   "singleQuote": true,
   "jsxSingleQuote": false,
-  "arrowParens": "always"
+  "arrowParens": "avoid"
 }

README.md

@@ -1,3 +1,75 @@
-# Wizeline Academy - 2021 React Bootcamp
+# Web Application
 
-Please refere to the following [GIST](https://gist.github.com/jparciga/83341911fbc8cd716be12af50c0e496a) for further instructions
+This was created using create-react-app 4
+Try it live @ Netlify -> https://uri-react.netlify.app/
+
+| Statements                  | Branches                | Functions                 | Lines             |
+| --------------------------- | ----------------------- | ------------------------- | ----------------- |
+| ![Statements](https://img.shields.io/badge/Coverage-12.82%25-red.svg) | ![Branches](https://img.shields.io/badge/Coverage-10.81%25-red.svg) | ![Functions](https://img.shields.io/badge/Coverage-9.8%25-red.svg) | ![Lines](https://img.shields.io/badge/Coverage-12.11%25-red.svg) |
+
+## Application Dependenciess
+
+These are the system dependencies you need to have in order to run the application.
+
+| Tool              | Version |
+| ----------------- | ------- |
+| React-Scripts     | 4.0.2   |
+| React             | >17.0.1 |
+| Styled Components |         |
+| Jest              |         |
+
+### Frontend
+
+| Tool              | Description                                               |
+| ----------------- | --------------------------------------------------------- |
+| React             | Using React Library to render the Single Page Application |
+| Styled Components | Using Styled Components to build CSS-in-JS                |
+|                   |                                                           |
+
+---
+
+### Testing
+
+| Tool | Description                                                      |
+| ---- | ---------------------------------------------------------------- |
+| Jest | Using Jest Testing Framework to ensure correctness functionality |
+|      |                                                                  |
+
+### Methodologies
+
+| Methodology | Description                                               |
+| ----------- | --------------------------------------------------------- |
+| SMACSS      | Using SMACSS methodology for CSS construction             |
+| BEM         | Using BEM structure for class names if needed.            |
+| i11y        | Building an application with accessibility best practices |
+| i18n        | Building an application ready for internationalization    |
+|             |                                                           |
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+Run: `npm run test:coverage` to check the coverage report.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.