This application uses NextJS.
To start a new project, click on the "Use this template" button.
Install dependencies to your project by running the following command:
yarn install
To run your application in the localhost, please use this command:
yarn dev
Please, use the following command to validate your code running static, unit, and integration tests:
yarn validate
The application use Base Web. Base Web is a design system for building websites in React. It is open-source.
The main benefits of the Base Web design system are:
- built-in accessibility
- performance
Styletron is the CSS-in-JS engine powering Base Web. That is one of the fastest solutions.
The project includes these forms of testing:
- Static Analysis: catch typos and type errors as you write the code.
ESLint statically analyzes your code to find problems. Prettier enforces a consistent code style. This project use TypeScript. By understanding JavaScript, TypeScript saves you time catching errors and providing fixes before run code.
- Unit: verify that individual, isolated parts work as expected.
- Integration: verify that several entities work together in harmony.
This application uses JavaScript Testing Framework - Jest with React Testing Library. Tests live in the tests folder, when is possible, next to the file they are testing.
Jest also collects code coverage information.
- End-to-end: a helper robot behaves like a user to click around the app and verify that it functions correctly, sometimes called "functional testing" or e2e.
These tests are written with cypress and Cypress Testing Library. End-to-end tests live in the cypress/e2e folder.
Use the following commands to open and add more Cypress tests:
yarn test:e2e:dev
Use the following commands to run Jest tests related to only the files that have changed:
yarn test:watch