Skip to content

brunoxd13/my-reads

Repository files navigation

REACT nanodegree BCH compliance Heroku Codacy Badge

logo


This is the first graduation project for the React Nanodegree Program from Udacity.

My reads is a project to manage the reading of books between three types, being: want read, read and read.

I opted to develop the project to create my layout from scratch and not use the layout provided by udacity.

Demo

🎮 Play with the demo

Getting Started

Prerequisites

To perform the project installation you need to have a package manager installed in your environment, such as the following:

Installing process

Cloning the porject

git clone https://github.com/brunoxd13/my-reads.git
cd my-reads

Instaling the project

yarn install
yarn start

or

npm install
npm run start

Testing

To test the project in development you can use this comand:

npm test

To test coverage of tests in project you can use this comand:

npm test -- --coverage

The expect result is like this:

----------------------------|----------|----------|----------|----------|-------------------|
File                        |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
----------------------------|----------|----------|----------|----------|-------------------|
All files                   |    45.53 |    36.17 |    46.43 |    56.38 |                   |
 src                        |     7.84 |        0 |        0 |    15.38 |                   |
  index.js                  |        0 |        0 |        0 |        0 |    1,2,3,4,5,7,14 |
  registerServiceWorker.js  |        0 |        0 |        0 |        0 |... 36,137,138,139 |
  setupTests.js             |      100 |      100 |      100 |      100 |                   |
 src/components/book        |       50 |    83.33 |    33.33 |       50 |                   |
  index.js                  |       50 |    83.33 |    33.33 |       50 | 19,20,22,26,27,29 |
 src/components/bookShelf   |       75 |       75 |    66.67 |       75 |                   |
  index.js                  |       75 |       75 |    66.67 |       75 |                21 |
 src/components/bookShelves |      100 |      100 |      100 |      100 |                   |
  index.js                  |      100 |      100 |      100 |      100 |                   |
 src/components/searchInput |      100 |      100 |      100 |      100 |                   |
  index.js                  |      100 |      100 |      100 |      100 |                   |
 src/pages/main             |       68 |       75 |    64.71 |    69.57 |                   |
  index.js                  |       68 |       75 |    64.71 |    69.57 |... 33,53,56,62,63 |
 src/service                |       75 |       50 |    54.55 |       75 |                   |
  BooksAPI.js               |       75 |       50 |    54.55 |       75 |    16,17,18,26,33 |
----------------------------|----------|----------|----------|----------|-------------------|

Packages

Packages used for the construction of the project:

Packages used for the development of the project:

Author

Bruno Russi Lautenschlager

License

This project is licensed under the MIT License - see the LICENSE file for details

Credits

Images:

About

Project to manage books in reading, to read and read. Completion of the first module of the course Nanodegree Developer React - Udacity

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published