create-eruption 🌋

The official template to create a new Eruption project.

Usage

To initialize a new project, run the following command (with you preferred package manager)):

npm init eruption@latest

yarn create eruption@latest

pnpm create eruption@latest

The CLI will ask you a few questions (in interactive mode) and then create a new project for you, but you can also pass a few flags to skip the interactive mode.

to skip the interactive mode you can pass the --name and --kit flags:

npm init eruption@latest -- --name my-project --kit core --yes

Available Kits

Name	Description	Repository
core	The core kit (React, Vite and Vitest).	https://github.com/eruptionjs/core
react-full	The full kit (React, Vite, Vitest, Mantine, React Router, Zustand, React Hook Form, Axios, and more).	https://github.com/eruptionjs/react-full
react-lib	The library kit (React, Vite, Vitest, TypeScript).	https://github.com/eruptionjs/react-lib

CLI Flags

Flag	Description	Default
--name	The name of the project.	undefined
--kit	The kit to use (e.g: core. The CLI will use the https://github.com/eruptionjs/core repository as base).	undefined
--yes	Whether to skip the confirm prompt.	false
--git	Whether to initialize a git repository.	true
--vscode	Whether to include or not .vscode folder	true

License

MIT @ EruptionJS and it's contributors.