midyan / react-p5

Simple ReactJS based page to play around with the p5.js library!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

p5.js React Playground

Simple ReactJS based page to play around with the p5.js library!

###What is this about This is a pre-setup and easy to use page with p5.js ready to go. It is built using the React-App package.

###What is needed to use it --NodeJs 6+
--git (Command line or GUI)
--Comand Line Interface(Linux Terminal or similar)

How to install and setup

First, you need to clone this repository to your machine/server

$ git clone https://github.com/midyan/react-p5.git [[directory_name/]]

Now, to install all its dependencies you need to navigate to the directory you cloned it into and run the following for Linux or OSx environments: ```sh $ sudo npm run setup ``` Or, if you are on Windows, open the PowerShell or CMD as Administrator and run: ```sh $ npm run setup ```
To start the project, simply run the command below and a localhost server will be created with everything up and running: ```sh $ npm run start ```

How to use it

The sketch file is located at '/routes/Home'. Now go and make the magic happen.

Also, since the ReactJs requires you to instantiate the p5 class for each component created, the 'p' argument is required in the sketch class. All the p5 functions, methods, objects and classes are contained inside this 'p' argument. Please refer to Instantiation Cases inside the p5 documentation.

Where am I going with this?

I mean to create a page where people could tinker with p5.JS easily and online. It will have the functionalities of codepen.io, but fucused solely on p5.JS programming. I will create a Tab Layout to manage multiple instaces of p5.js at the same time, as well many pre-made example for everyone to play around with. This work is inspired mostly by the work of Daniel Shiffman. He is an awesome guy, so you should definitely follow his YouTube Channel, buy his book or simply throw money at him.

About

Simple ReactJS based page to play around with the p5.js library!

License:MIT License


Languages

Language:JavaScript 81.4%Language:CSS 13.8%Language:HTML 4.7%