https://github.com/emanueledancelli/sketching
scaffolding cli tool for p5js projects
https://github.com/emanueledancelli/sketching
nodejs p5js parcel scaffolding-cli
Last synced: about 1 month ago
JSON representation
scaffolding cli tool for p5js projects
- Host: GitHub
- URL: https://github.com/emanueledancelli/sketching
- Owner: emanueledancelli
- Created: 2020-03-31T15:12:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T10:34:17.000Z (about 4 years ago)
- Last Synced: 2025-03-18T13:55:16.911Z (about 1 year ago)
- Topics: nodejs, p5js, parcel, scaffolding-cli
- Language: JavaScript
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sketching
[](https://opensource.org/licenses/MIT)
> p5js projects scaffolding node cli tool
Easily create new projects in p5js. Be faster iterating ideas with the addition of hot module reloading. Release a more optimized sketch with automatic code bundling and code splitting.
## Description
Scaffolds a new project featuring [parcel](https://parceljs.org/) and [p5js](https://p5js.org/).
- Creates a new directory for the project.
- Copies template files and installs dependencies through npm.
- Provides two scripts to start using the template right away.
## Installation
Be sure to have [node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) installed on your machine before starting.
OS X & Linux:
```shell
npm install -g sketching
```
or
```shell
npm install --global sketching
```
## Usage
```shell
sketching 1.0.0
USAGE
sketching new
ARGUMENTS
The sketch title required
GLOBAL OPTIONS
-h, --help Display help
-V, --version Display version
--no-color Disable colors
--quiet Quiet mode - only displays warn and error messages
-v, --verbose Verbose mode - will also output debug messages
```
## Built with
The tool is build with [node.js](https://nodejs.org/en/) and the help of a few other libraries.
CLI tool:
- [caporal](https://github.com/mattallty/Caporal.js?)
- [chalk](https://github.com/chalk/chalk)
- [figlet](https://github.com/patorjk/figlet.js)
- [ora](https://github.com/sindresorhus/ora)
Template:
- [p5js](https://p5js.org/)
- [parcel](https://parceljs.org/)
## Credits
Emanuele Dancelli - emanueledancelli@gmail.com
## License
[MIT](https://mit-license.org/)