Testing stickler

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env"],
+}

.eslintrc.json

@@ -0,0 +1,28 @@
+{
+  "env": {
+    "browser": true,
+    "es6": true,
+    "jest": true
+  },
+  "parser": "babel-eslint",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module",
+    "ecmaFeatures": {
+        "jsx": true
+    },
+    "experimentalObjectRestSpread": true
+  },
+  "extends": ["airbnb"],
+  "plugins": ["react"],
+  "rules": {
+    "react/jsx-filename-extension": ["warn", { "extensions": [".js", ".jsx"] }],
+    "import/no-unresolved": "off",
+    "no-shadow": "off",
+    "arrow-parens": ["error", "as-needed"],
+    "jsx-a11y/href-no-hash": "off",
+    "jsx-a11y/img-has-alt": "off",
+    "no-mixed-operators":"off",
+    "import/extensions":"off"
+  }
+}

.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.stickler.yml

@@ -0,0 +1,11 @@
+
+# add the linters you want stickler to use for this project
+linters:
+  eslint:
+    # indicate where is the config file for stylelint
+    config: './.eslintrc.json'
+
+# PLEASE DO NOT enable auto fixing options
+# if you need extra support from you linter - do it in your local env as described in README for this config
+
+# find full documentation here: https://stickler-ci.com/docs

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Gabriela Cruz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,5 +1,94 @@
-## Readings tracker app
 
-Initial setup for readouts tracker.
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
 
-More information coming soon.
+# Tracking mobile web app with react
+This project is a tracking app to measure how much do you read during a day. Taking in count only: books, articles, audiobooks, mangas, and comics.
+This is a manual tracking to acquire the habit of reading.
+
+
+## Demo down below
+Visit [Readouts tracker](https://readouts-tracker.herokuapp.com/ ) to try the live version.
+
+## Built With ✨
+- React 16.13
+- react-router 5.1
+- react-router-dom 5.1
+- create-react-app
+- JavaScript ES6
+
+
+## Prerequisites
+* Node.js installed
+You will need Node.js up to v8
+
+* System dependencies
+Windows/ Mac
+
+
+## How to Install locally
+Clone project and run
+`npm install`
+`npm start`
+
+This will launch project on **localhost:3000**
+
+
+### How to use
+
+#### Login page
+If you already registered, you only need to type your email and password to sign in.
+
+#### SignUp page
+To signup, you need to fill a form with your first name, last name, email, and password. After this, you will be redirected to the main page.
+
+#### Categories page
+You will see a list of categories here, you only need to click or tap on one to select it. You will be redirected to the track reading section.
+
+#### Track Reading page
+Here you can start your manual tracking. You write a description of what you are reading, click or tap start to measure. Don't forget to save first before you edit or stop the time.
+
+#### Measurements page
+Here you can see what do you read more during a day. Showing a pie chart to represent the percentage of the categories that you read.
+
+
+## How to contribute and partipate
+Fork this repo and submit a PR for review and potential merge to main branch. Feel free to leave feedback :smile:
+
+## How to run tests
+If you want to use npm, run:
+`npm test`
+
+If you want to use yarn, run:
+`yarn test`
+
+## Authors
+
+👨‍💻 **Gabriela Cruz**
+
+- Github [@viricruz](https://github.com/ViriCruz/)
+
+- email me at [email protected]
+
+- Linkedin [@viricruz](https://www.linkedin.com/in/viricruz/)
+
+## License
+
+This project is [MIT](LICENSE) licensed.
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/viricruz/readouts_tracker.svg?style=flat-square
+[contributors-url]: https://github.com/viricruz/readouts_tracker/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/viricruz/readouts_tracker
+[forks-url]: https://github.com/viricruz/readouts_tracker/network/members
+[stars-shield]: https://img.shields.io/github/stars/viricruz/readouts_tracker
+[stars-url]: https://github.com/viricruz/readouts_tracker/stargazers
+[issues-shield]: https://img.shields.io/github/issues/viricruz/readouts_tracker
+[issues-url]: https://github.com/viricruz/readouts_tracker/issues
+[license-shield]: https://img.shields.io/github/license/viricruz/readouts_tracker
+[license-url]: https://github.com/viricruz/readouts_tracker/blob/master/LICENSE.txt