Skip to content

inpyjamas/p5-starter-kit

Repository files navigation

P5.js Starter Kit

All Contributors

A opinionated p5.js starter kit. Generates zp files on the fly using always the latest version of:

  • p5.js
  • p5.sound.js
  • p5.easing.js

Some additional files are included to make it easier to hit the ground running.

  • .editorconfig
  • .vscode/settings.json (open folder in VSCode)
  • .vscode/extensions.json (extensions to have in VSCode)
  • index.html (basic HTML5 boilerplate)
  • index.js (basic p5.js boilerplate)

API Usage

The starter kit generator provides an API endpoint that can be customized with URL parameters:

Basic Usage

  • /api/package - Downloads full kit with latest versions
  • /api/package?minimal=true - Downloads minimal kit (no dev config files)

Version Specification

You can specify exact versions for each package:

  • /api/package?p5=1.4.0 - Use specific p5.js version
  • /api/package?p5-easing=1.0.0 - Use specific p5-easing version
  • /api/package?p5=1.4.0&p5-easing=1.0.0 - Specify both versions
  • /api/package?p5=1.4.0&minimal=true - Combine with minimal mode

Error Handling

  • Returns 404 if specified version doesn't exist
  • Returns 500 for other server errors
  • Error responses include JSON with descriptive messages

Examples

# Latest versions (default)
curl -O https://your-domain.com/api/package

# Specific p5.js version
curl -O "https://your-domain.com/api/package?p5=1.4.0"

# Both packages with specific versions
curl -O "https://your-domain.com/api/package?p5=1.4.0&p5-easing=1.0.0"

# Minimal kit with specific version
curl -O "https://your-domain.com/api/package?p5=1.4.0&minimal=true"

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Fabian Morón Zirfas
Fabian Morón Zirfas

💻 🚇 🎨
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

About

An opinionated starter kit for p5.js projects

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •