ViriCruz / readouts_tracker

Readings tracker made with React, Redux and RoR

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License

Tracking mobile web app with react

This project is a tracking app to measure how much 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.

categories

track

chart

Demo down below

Visit Readouts tracker 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

Prerequisites

  • Node.js installed You will need Node.js up to v8
  • System dependencies Windows/ Mac

Prerequisites for the API

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.

Potential future features

  • Display weekly statistics.
  • Display in which hours you read the most.

How to run automated tests

You will find a README.md file inside each folder which contains specific instructions on how to do it.

How to contribute and participate

Fork this repo and submit a PR for review and potential merge to the main branch. Feel free to leave feedback. 😄

Authors

👨‍💻 Gabriela Cruz

License

This project is MIT licensed.

About

Readings tracker made with React, Redux and RoR


Languages

Language:Ruby 53.8%Language:JavaScript 43.6%Language:HTML 1.4%Language:CSS 1.3%