Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lamiasristy/trackyourreading_ui
The objective of this project was to create a mobile app, which can track any specific things and presented with a list of things to be measured. This app is using a back-end part, for the Back-End part, where I have created API and endpoints, I have used Rails.
https://github.com/lamiasristy/trackyourreading_ui
rails-api react-hooks react-redux react-router
Last synced: 25 days ago
JSON representation
The objective of this project was to create a mobile app, which can track any specific things and presented with a list of things to be measured. This app is using a back-end part, for the Back-End part, where I have created API and endpoints, I have used Rails.
- Host: GitHub
- URL: https://github.com/lamiasristy/trackyourreading_ui
- Owner: LamiaSristy
- Created: 2021-03-13T17:08:05.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2021-03-19T21:56:54.000Z (over 3 years ago)
- Last Synced: 2024-10-09T17:13:37.788Z (about 1 month ago)
- Topics: rails-api, react-hooks, react-redux, react-router
- Language: JavaScript
- Homepage:
- Size: 587 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Track Your Reading
The objective of this project was to create a mobile app, which can track any specific things and presented with a list of things to be measured. This app is using a back-end part, for the Back-End part, where I have created API and endpoints, I have used Rails.
## Application Description:
1. An user needs to Sign-up with a username and password.
2. The username's length needs to be at least 4.
3. The password's length needs to be at least 6.
4. After Log-in/Sign-in the user is presented with the list of books.
5. If the user is new, then they can add books by clicking the `+` sign in the header.
6. While creating the books, the user has to enter a name, author, genre, and how many pages.
7. After successful creation, the user can see the newly created book on the main page.
8. To start tracking, the user needs to click on the book object.
9. Then they will drag to create the tracking page, where they need to add the date and number of pages they are in.
10. After clicking the button save, they have saved the page numbers.
## `Build-With:`
- React-virtual DOM concepts
- VScode
## `Live Demo:`
[Track-Your-Reading--App](https://trackreading.herokuapp.com/).
[Back-End--Api](http://serene-inlet-93388.herokuapp.com/).
# Getting Started:
### `Prerequisites`
To get this project up and running locally, "npm install" is needed to be run in order to include all dependencies used for this project.
**To get this project set up on your local machine, follow these simple steps:**
1. Open Terminal.
2. Navigate to your desired location to download the contents of this repository.
3. Copy and paste the following code into the Terminal: git clone `https://github.com/LamiaSristy/TrackYourReading_UI`.
4. Into the Terminal: run `cd TrackYourReading_UI`.
5. Into the Terminal: run `npm install`.
6. Into the Terminal: run `npm start`.
7. To see the website in the browser, open browser and load `localhost:3000`.
**To run the test suits:**
1. Into the Terminal: run `npm test`.
2. Press `a` to run all tests.
## `Author Details::`
👤 **Lamia Sristy**
- Github: [@LamiaSristy](https://github.com/LamiaSristy)
- Linkedin: [@LamiaSristy](https://www.linkedin.com/in/lamia-hemayet-sristy/)
- E-mail: Email
- Twitter: [@LamiaSristy](https://twitter.com/lsristy1)
## `Show your support:`
Give ⭐ Star me on GitHub — it helps!
## 📝 `License`
This project is [MIT](lic.url) licensed.