Core
Boilerplate for React/Typescript, built on top of Vite
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.
Using with Docker
To use Eruption with Docker, follow these steps:
Pre-requisites:
- Install Docker for your platform.
- Install docker-compose for your platform.
- Make sure you are in your project directory.
- 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:
- Make sure you are in your project directory.
- 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.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- Vite
Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects
- Templates & Themes
A template or theme refers to a pre-designed layout or structure that provides a basic framework for building a specific type of application or website. It typically includes good design, placeholder content and functional features, allowing developers to customize and fill in the details according to their specific needs.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.