README.md

10print using a p5.js Svelte App

very good! 👋👋🏿👋🏽👋🏻👋🏾👋

This was made by Dan Shiffman seeding his wonderful teachings into my little brain! This is also my first formal step into generative algorithms beyond just thinking about them for a year.

The project uses my project skeleton for creating a p5.js sketch in a Svelte app.

Feel free to clone and tweak this, and add contributions as pull requests!

Or, to create your own new project based on that p5 template I'm using:

npx degit tonyketcham/p5-svelte-template 10print
cd p5-svelte-app

Note that you will need to have Node.js installed.

Get started

Install the dependencies...

cd 10print
npm install

...then start Rollup:

npm run dev

Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

p5.js instance mode

Since Svelte doesn't allow us to globally expose the p5 library, we must instead do some trickery and use p5's instance mode:

import p5 from "p5";

export default function sketch(node) {
  new p5((instance) => workspace(instance), node);
}

/**
 * The main method
 *
 * @param {p5} p5 sketch instance, scoped where many may exist on the same page
 */
const workspace = (p5) => {
  let x = 100;
  let y = 100;

  p5.setup = () => {
    p5.createCanvas(400, 400);
  };

  p5.draw = () => {
    p5.background(0);

    if (p5.mouseIsPressed) {
      p5.fill(255);
    } else {
      p5.fill(0);
    }
    p5.ellipse(p5.mouseX, p5.mouseY, 50, 50);
  };
};

This has the benefit of allowing multiple sketches per page with seperation of concerns.

Building and running in production mode

To create an optimised version of the app:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Single-page app mode

By default, sirv will only respond to requests that match files in public. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.

If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for any path. You can make it so by editing the "start" command in package.json:

"start": "sirv public --single"

Using TypeScript

This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:

node scripts/setupTypeScript.js

Or remove the script via:

rm scripts/setupTypeScript.js

Deploying to the web

With Vercel

Install vercel if you haven't already:

npm install -g vercel

Then, from within your project folder:

cd public
vercel deploy --name my-project

With surge

Install surge if you haven't already:

npm install -g surge

Then, from within your project folder:

npm run build
surge public my-project.surge.sh

---

This project is a fork of the official Svelte template.