p5mirror

github pages p5projects-index Edit link above for your github pages url

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

# keep p5js editor changes in sync by running the command again
# editte scripts will be downloaded

Details

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

# 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

Your mirror edits here

# Edit this line for your editor.p5js user name

bin/mirror.sh --user p5name

bin/mirror.sh --user p5name --clean
bin/mirror.sh --user p5name --full
bin/mirror.sh --user p5name --verbose

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

p5mirror/forks

Required apps

https://nodejs.org/en/download

For Microsoft Windows OS

these scripts require bash shell
steps to enable bash on Windows OS
Install Git from https://git-scm.com/download/win
Open VS Code (or quit an open again)
Open the command palette using Ctrl + Shift + P.
Type - Select Default Profile
Select Git Bash from the options
source 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

p5mirror

How ? Quick start

Details

Your mirror edits here

Why ?

Listing of editor.p5js projects

p5mirror/forks

Required apps

For Microsoft Windows OS

Recommended apps

VS Code extensions

p5mirrorLib

Usage

mirror script details

Generated files

Shell scripts to download and unzip

JSON source from editor.p5js