p5mirror

How ? Quick start

# Terminal commands to get started

# Install nodejs
open https://nodejs.org/en/download

# Fork this repo and name it p5mirror-p5name
# where p5name is our editor.p5js user name
# run this bash script in the root of your repo

bin/mirror.sh --user p5name

# and then commit changes in github desktop

Your mirror here

# Edit this line for your editor.p5js user name
bin/mirror.sh --user p5name

Why ?

mirror your editor.p5js sketches into a git repo

Where are my editor.p5js sketches and collections ?
- make sure that all your editor.p5js projects are available in a git repo
- be prepared if editor.p5js server fails
How ?
- command line scripts download your p5 sketches with associated media files
- mark down files generated to list sketches and collections
- index file generated for your projects for github pages

Listing of editor.p5js projects

Generated listing of editor.p5js projects

p5projects-index

p5mirror/forks

Required apps

https://nodejs.org/en/download

For Microsoft Windows OS

these scripts require bash shell
test on macos
for Windows try:
- how-do-i-use-bash-on-windows

Recommended apps

https://code.visualstudio.com/
https://desktop.github.com/

VS Code extensions

https://marketplace.visualstudio.com/items?itemName=samplavigne.p5-vscode
https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

p5mirrorLib

p5mirrorLib repo is used instally by this repo
github p5mirrorLib
Use p5mirrorLib repo directly to keep your sketches in sync with your editor.p5js account.

Usage

# p5name is the place holder for your editor.p5js user name

# fork this repo and name it p5mirror-p5name

# in p5mirror-p5name folder, run bin/mirror.sh to
# download p5js scripts for a user account
#   and create markdown listing files
#   only projects updated since last mirror are downloaded
#
bin/mirror.sh --user p5name

# full update, download all projects
#
bin/mirror.sh --user p5name --full

# run in verbose mode to show details of steps for debugging
#
bin/mirror.sh --user p5name --verbose

# remove sketches not present online
#
bin/mirror.sh --user p5name --clean

mirror script details

See bin/mirror.sh for details steps
These steps can be run independantly

Generated files

All generated files are stored in the downloads directory

Shell scripts to download and unzip

JSON source from editor.p5js

This site is open source. Improve this page.