Repo for toxiclibs.js website and examples
JavaScript CSS Processing HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Toxiclibs.js Examples

http://haptic-data.com/toxiclibsjs

The Examples

This repository contains the site files for toxiclibs.js (github, NPM, bower) . The site is an Express.js server and you can learn more about how this works in the Technical Overview. The site's examples are configured in the sitemap.js and located in src/javascripts/examples/. Each example ending in .pde is a processing.js file.

Run the site locally

Install dependencies

npm install

Run the server

npm start

View in browser at http://localhost:3004

Technical Overview

  1. Node.js is used for the server and build processes
  2. Grunt is used for development tasks, such as building javascript files and deploying files to s3.
  3. Docco is used for rendering annotated source and injecting it into the example templates
  4. Jade is used for server-side and client-side templating
  5. Less is used for stylesheet pre-processing
  6. Require.js is used for loading and building site javascript files.

Creating a new example

  1. Create a new javascript file in the src/javascripts/examples/ directory
  2. Add a new entry into the sitemap.js file under examples, including the template that should be used, i.e. pjs, require, canvas2d or index.

Note: after you add an entry to sitemap.js you will need to re-start the server for it to see the changes. Or you can use a tool like forever.


Project developed by Kyle Phillips

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

http://creativecommons.org/licenses/LGPL/2.1/

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA