Overview:

Essencium is a React-based starter monorepo that includes a component library, documentation, and a boilerplate application. It provides a set of commands for setup, cleaning, linting, formatting, testing, development, and building the project.

Features:

• Component Library: A collection of reusable React components.
• Documentation: Comprehensive documentation to guide users in using and customizing the component library and boilerplate application.
• Boilerplate Application: A pre-configured React application that serves as a starting point for building web applications.

Installation:

To install the Essencium theme, follow these steps:

1. Clone the project repository.

2. Navigate to the project directory in the command line.

3. Run the following command to set up the project environment:

   setup-env
   

   This command should be executed only once during project setup. It installs all the dependencies and sets up Husky for commit linting.

4. To clean up the project, use the following command:

   clean
   

   This command deletes all the dist folders and node_modules folders.

5. If you want to clean the project and reinstall all the dependencies, use the following command:

   clean:install
   

6. To perform ESLint linting throughout the codebase, use the following command:

   lint
   

7. To perform Prettier formatting throughout the codebase, use the following command:

   format
   

8. To run all the existing tests with Vitest.dev, use the following command:

   test
   

9. To start the Vite development server and prepare the library and application for development, use the following command:

   dev
   

   This command executes nx dev app and launches the Vite development server with Hot Module Replacement (HMR) support.

10. To build the application for production, use the following command:

    build
    

    This command executes nx build app and creates a dist folder with the production-ready application.

Summary:

Essencium is a React-based starter monorepo that includes a component library, documentation, and a boilerplate application. It provides a set of commands for setting up the project, cleaning, linting, formatting, testing, development, and building the application. By following the installation guide and utilizing the provided features, users can easily start and customize their web applications using the Essencium theme.