Pi-factory NPM

IMPORTANT -Initial Project Setup!

In the root of the project please run

node bin/dependency_trim.js -> one time use
Configure the optional dependencies
Assure everything still works fine and commit your options in a single commit

#This project was bootstrapped with Pitech template.

Available Scripts

In the project directory, you can run:

yarn start - runs the app in the development mode. Open http://localhost:3000 to view it in the browser.
yarn test - launches the test runner in the interactive watch mode.
yarn test:e2e - launches app on port 3099 and starts the E2E environment.
yarn test:mutation - launches the test runner and applies mutations on written code.
yarn lint - lints project files according to eslint rules
yarn lint:fix - same as yarn lint, but also fixes errors, when possible. Typical use case: local development environment, git hooks.

Due to CRA template limitations (we can change only scripts and dependencies inside generated package.json) all configuration is done by adding config files where possible. Also no devDependencies for now, sorry.

Redux configuration

The template provides basic Redux configuration using Redux Toolkit

IMPORTANT: Form Solutions

REMOVED Final Form project

Basic implementation contains a FormWrapper that should be used to declare a form
A TextField, CheckboxField and ConditionField is provided by default A set of validators is also provided within the final-form directory

React Hook Form project

Implementation details can be found here.

Testing

E2E

Cypress is the default library for e2e testing, contains a minimal implementation with custom commands For the local setup please use yarn test:e2e

Unit and integration testing

React Testing library is used in this case. Use yarn test or yarn test:coverage for running tests.
There is already a test and mock folder set with basic tests for the Counter component. In the mock folder you will also find a wrappers file that contains some helper function to wrap your components with Redux and Intl providers.

REMOVED Mutation testing

Mutation tester provider is Stryker Stryker provides a real coverage report of the current tests and offers an insight on where bugs might appear

In order to see this report locally, run yarn test:mutation This report can pe visualised on each branch pipeline by triggering a manual job and then downloading the artifact with the report on a html format In order to add/remove tests or files from mutation scope, please edit stryker.conf.js

Stryker can be removed by adding mutation as an argument to the ./bin/clean_project.sh

Internationalization

Translations is provided using React Intl.
Also a DynamicFormattedMessage component is provided to wrap the intl import and provide conditional rendering of the text

Prettier

Prettier is added to force consistent formatting. Don't like trailing semicolons? Feel free to tweak prettier rules inside .prettierrc file to match your code style.

Eslint configurations

The template extends CRA ESLint rules with a custom set, tailored for the reasonable and clean development process.

Eslint rules are commented for your convenience feel free to tweak or remove them inside .eslintrc
Import order not configured, a plugin can be found here

REMOVED Open API Tools generator project

The provided template uses fetch, if you wish to modify it, please consult the project, axios/superagent are also suported

By providing a valid endpoint for swagger.json retrieval in the .env file the script found at bin/install_api.sh will generate models and APIs defined in that particular swagger.json