Overview

Eruption is a boilerplate for React/Typescript projects built on top of Vite. It aims to provide a fast and reliable development environment. The boilerplate includes features such as Vite, React, Typescript, Vitest, Testing Library, and Dev Tools.

Features

• Fast: Eruption is built on top of Vite, which ensures fast development and tests.
• Vitest: Eruption includes Vitest for efficient testing.
• Boilerplate: Eruption provides a ready-to-use setup with Vite, React, and Typescript.
• Testing Library: The boilerplate includes Testing Library for easy and effective testing.
• Dev Tools: Eruption comes with ESLint and Prettier for code formatting and linting.
• CommitLint: Eruption follows the Conventional Commits best practice and is configured with CommitLint for consistent commit messages.
• Husky and Lint-Staged: Eruption utilizes Husky and Lint-Staged to run code validations and tests before committing changes.

Installation

There are two ways to install Eruption:

1. Using the template directly from GitHub (through the “Use Template” button).
2. Using the CLI.

If you prefer to use the CLI, run the following command in your terminal:

npm install -g eruption-cli

To start the project, use the following command:

eruption new my-project

Using with Docker

To use Eruption with Docker, follow these steps:

Pre-requisites:

• Install Docker for your platform.
• Install docker-compose for your platform.

1. Make sure you are in your project directory.
2. Run the following command:

docker-compose up

Using on Production with Docker

DISCLAIMER: This Docker configuration is for demonstration purposes only. If you plan to use this configuration in a production environment, it is your responsibility to ensure that it is secure and optimized for your needs. Thoroughly test and review all aspects of the configuration before deploying it in a production environment. The author of this demonstration assumes no responsibility for any issues that may arise from the use of this configuration.

To use Eruption on production with Docker, follow these steps:

1. Make sure you are in your project directory.
2. Run the following command:

docker-compose up

Summary

Eruption is a boilerplate for React/Typescript projects built on top of Vite. It provides a fast and reliable development environment with features such as Vite, React, Typescript, Vitest, Testing Library, and Dev Tools. The installation process includes options to use the template directly from GitHub or through the CLI. Additionally, Eruption can be used with Docker for easy deployment. The boilerplate follows best practices for commit messages and includes linting and testing to ensure code quality.