No description or website provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.docz
config
cypress
docz/components
public
scripts
src
. browserslistrc
.babelrc
.editorconfig
.eslintignore
.eslintrc.json
.gitignore
.jestconfig.json
.nvmrc
README.md
cypress.json
doczrc.js
package-lock.json
package.json
yarn.lock

README.md

My Reads

Project made to finish a first module in React Nanodregree program on Udacity.

Project dependencies

To do this project, was used some libraries, like:

  1. axios
  2. babel
  3. eslint
  4. fontawesome
  5. history
  6. husky
  7. i18next
  8. i18next-browser-languagedetector
  9. jest
  10. normalize
  11. prop-types
  12. react
  13. react-bulma-components
  14. react-i18next
  15. react-router
  16. react-router-dom
  17. react-test-renderer
  18. styled-components
  19. webpack
  20. cypress
  21. docz

Those are main libraries of the project.

Setup

To init and configure the project it's very simple, there's a lot of scripts done for a better automatization tasks like those.

Intall

The first necessary step is to install all project dependencies, you can just run on root source:

yarn

or

npm i

Wait all while all dependencies are downloaded and configured.

Start

After that first step has been done, you can start a development local server with:

yarn start

or

npm start

A development server will be started at your localhost laptop or computer.

Tests

To run all project tests, just run:

yarn test

or

npm test

It's possible to test your UI by using Cypress, there's a three commands:

To test the UI in your terminal, run:

yarn cypress

or

npm cypress

To test the UI by using and showing a browser, like chrome, run:

yarn cypress:chrome

or

npm cypress:chrome

And, if you want choose a specific test or to see the all possibles tests, run:

yarn cypress:open

or

npm cypress:open

Documentation

It's possible to test the app share components, by using Docz

To see a full documentation, you can run:

yarn docz:dev

or

npm docz:dev

All matches files will be tested.

ESLint

If you need check some code format, the project has been configured with ESLint, so you can check through:

yarn lint

or

npm lint

If some error was found, just run the same command with lint:fix to try fixed it.

If you want to see a demo of the app: demo

If you want to see a documentation of the app: documentation

The app has been hosted by Netlify.

Thanks