Project made to finish a first module in React Nanodregree program on Udacity.
To do this project, was used some libraries, like:
- axios
- babel
- eslint
- fontawesome
- history
- husky
- i18next
- i18next-browser-languagedetector
- jest
- normalize
- prop-types
- react
- react-bulma-components
- react-i18next
- react-router
- react-router-dom
- react-test-renderer
- styled-components
- webpack
- cypress
- docz
Those are main libraries of the project.
To init and configure the project it's very simple, there's a lot of scripts done for a better automatization tasks like those.
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.
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.
To run all project tests, just run:
yarn test
or
npm test
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
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.
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