Project

.eslintrc.json

@@ -0,0 +1,22 @@
+ {
+    "env": {
+      "browser": true,
+      "es6": true,
+      "jest": true
+    },
+    "parserOptions": {
+      "ecmaFeatures": {
+        "jsx": true
+      },
+      "ecmaVersion": 2018,
+      "sourceType": "module"
+    },
+    "extends": ["airbnb", "plugin:react/recommended"],
+    "plugins": ["react"],
+    "rules": {
+      "react/jsx-filename-extension": ["warn", { "extensions": [".js", ".jsx"] }],
+      "import/no-unresolved": "off",
+      "no-shadow": "off",
+      "arrow-parens": ["error", "as-needed"]
+    }
+}

.stickler.yml

@@ -0,0 +1,22 @@
+# add the linters you want stickler to use for this project
+linters:
+  rubocop:
+    display_cop_names: true
+    # indicate where is the config file for stylelint
+    config: './rubocop.yml'
+  eslint:
+    # indicate where is the config file for stylelint
+    config: './.eslintrc.json'  
+
+# add the files here you want to be ignored by stylelint
+files:
+  ignore:
+    - "**/db/*"
+    - "**/bin/*" 
+    - "**/config/*"
+    - "**/Guardfile"
+    - "**/Rakefile"
+    - "**/README.md"
+    - "**/node_modules/**/*"
+    - "**/Gemfile"
+    - "**/Gemfile.lock"

README.md

@@ -1,5 +1,75 @@
-## 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
+- Ruby on Rails
+
+* System dependencies
+Windows/ Mac
+
+
+### 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:
+
+## 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

readouts-tracker-api/.gitignore

@@ -0,0 +1,27 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

readouts-tracker-api/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

readouts-tracker-api/.rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  Exclude:
+    - "db/**/*"
+    - "bin/*" 
+    - "config/**/*"
+    - "Guardfile"
+    - "Rakefile"
+    - "README.md"
+    - "Gemfile"
+    - "node_modules/**/*"
+    - "config/application.rb"
+    - "db/*"
+  DisplayCopNames: true
+
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Include:
+    - "app/controllers/*"
+    - "app/models/*"
+  Max: 20
+Metrics/AbcSize:
+  Include:
+    - "app/controllers/*"
+    - "app/models/*"
+  Max: 50
+Metrics/ClassLength:
+  Max: 150
+Metrics/BlockLength:
+  ExcludedMethods: ['describe']
+  Max: 30
+
+Style/Documentation:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/EachForSimpleLoop:
+  Enabled: false
+Style/AndOr:
+  Enabled: false
+Style/DefWithParentheses:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Layout/HashAlignment:
+  EnforcedColonStyle: key
+Layout/ExtraSpacing:
+  AllowForAlignment: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+Lint/RaiseException:
+  Enabled: false
+Lint/StructNewOverride:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: false
+Style/HashTransformKeys:
+  Enabled: false
+Style/HashTransformValues:
+  Enabled: false

readouts-tracker-api/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.1

readouts-tracker-api/Gemfile

@@ -0,0 +1,54 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.5.1'
+gem 'figaro'
+gem 'rubocop'
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 6.0.3'
+# Use postgresql as the database for Active Record
+gem 'pg', '>= 0.18', '< 2.0'
+# Use Puma as the app server
+gem 'puma', '~> 4.1'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.7'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use Active Model has_secure_password
+gem 'bcrypt', '~> 3.1.7'
+gem 'jwt'
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.4.2', require: false
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+gem 'rack-cors', '~> 0.4.0'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: %i[mri mingw x64_mingw]
+  %w[rspec-core rspec-expectations rspec-mocks rspec-rails rspec-support].each do |lib|
+    gem lib, git: "https://github.com/rspec/#{lib}.git", branch: 'master' # Previously '4-0-dev' or '4-0-maintenance' branch
+  end
+  gem 'capybara'
+end
+
+group :test do
+  gem 'database_cleaner'
+  gem 'factory_bot_rails'
+  gem 'faker'
+  gem 'shoulda-matchers', '~> 3.1'
+end
+
+group :development do
+  gem 'listen', '~> 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]