Overview

This article provides instructions and guidance for getting started with a development repository, including installation, developing components, testing, linting, and publishing the library. It also provides information on additional resources such as bundler Rollup.js, code formatter Prettier, testing framework Jest, and linting tools ESLint and stylelint.

Features

• Developing: Build a version of the library, run the watcher, and open Storybook for manual testing.
• Proposals (Babel): Includes Babel plugins for smoother development.
• Styling your components: Supports SCSS and CSS out of the box, with the ability to import styles into components.
• Testing: Uses Jest and @testing-library/react for testing components.
• Linting: Set up with ESLint and configured with eslint-config-react-app and eslint-config-prettier for code quality.
• Publishing your library to NPM: Provides instructions for releasing the library to NPM or a private registry.
• Storybook: Allows for custom layouts, styling, and more information about Storybook.
• Deploy Storybook to GitHub Pages: Provides instructions for deploying the Storybook to GitHub Pages.

Installation

To get started with this repository, follow these steps:

1. If you are familiar with Git, clone the repository using the provided URL. Otherwise, click the link to download the .zip file and extract its contents.
2. Open your terminal and navigate to the project directory.
3. Run the command yarn start to serve the Storybook and begin development.

Summary

This article provides a comprehensive guide for getting started with a development repository, including installation, developing components, testing, linting, and publishing the library. It also mentions additional resources such as bundler Rollup.js, code formatter Prettier, testing framework Jest, and linting tools ESLint and stylelint. By following these instructions, developers can easily set up and start working with the repository for their projects.