p5-project-starter CLI

A command-line interface tool for quickly setting up p5.js projects with Vite.

Prerequisites

Before you begin, ensure you have installed:

• Node.js (which comes with npm)

Installation

To install the p5-project-starter CLI globally, run:

npm install -g p5-project-starter

This will make the create-p5-project command available globally on your system.

Usage

To create a new p5.js project, run:

create-p5-project my-project-name

Replace my-project-name with your desired project name. If you don't provide a name, you'll be prompted to enter one.

After running the command:

1. Navigate into your new project directory:

   cd my-project-name

2. Install the project dependencies:

   npm install

3. Start the development server:

   npm start

This will open your default browser with your p5.js sketch running.

Features

• Quick setup of p5.js projects
• Vite for fast development and optimized builds
• Hot Module Replacement for quick refresh during development
• Basic CSS for full-screen canvas
• Easy-to-use npm scripts for development and building

Project Structure

The created project will have the following structure:

my-project-name/
├── index.html
├── sketch.js
├── styles.css
├── vite.config.js
├── package.json
└── README.md

Commands

In your created project, you can run:

• npm start: Starts the development server
• npm run build: Builds the project for production //- npm run preview: Previews the built project

Contributing

Contributions, issues, and feature requests are welcome!

License

This project is MIT licensed.