Overview

Flotiq components for React is a project that provides a collection of components for building React applications. It uses eslint for code linting and does not have a React app to start with, but it includes a storybook part for showcasing the components. The build storybook is available here.

Features

• Collection of React components for building applications
• Integration with eslint for code linting
• Storybook part for showcasing components
• Ability to compile components into a dist directory for publishing on npm registry
• Testing package with gherkin, cucumber, and jest
• Optional feature to eject from the build tool and customize configuration files

Installation

To install Flotiq components for React:

1. In the project directory, run the command yarn install to install all dependencies. Please use yarn instead of npm for this step.
2. To start the storybook server, run yarn storybook. The server will be available at http://localhost:6006/.
3. Run yarn compile to compile the components into the dist directory and prepare them for publishing on the npm registry.
4. To test the package, run yarn test. The tests are written using gherkin, cucumber, and jest.

Note: If you are not satisfied with the build tool and configuration choices, you can eject using the command npm run eject. Ejecting is a one-way operation and cannot be reversed. Ejecting will remove the single build dependency from your project and copy all the configuration files and transitive dependencies (webpack, Babel, ESLint, etc.) into your project, giving you full control over them. However, you don’t have to use eject if you don’t need to customize the build tool.

Summary

Flotiq components for React is a project that provides a collection of React components for building applications. It includes eslint for code linting and a storybook part for showcasing the components. The installation process involves installing dependencies, starting the storybook server, compiling the components, and running tests. Ejecting is an optional feature for customization.