Skip to content

code-not-art/sketch

Repository files navigation

Make Code Not Art

TypeScript libraries for creating procedural art in the browser.

Monorepo Structure

The repository is a monorepo containing reusable packages and standalone applications that rely on them. The monorepo is configured using pnpm and is managed using nx.

This monorepo is organized with the following directory structure:

.
├── apps/
│   └── demos
└── packages/
    ├── core
    └── sketch
Component Path Published Location Description
Demos apps/demos/ Not Published Runnable app using Sketch components - useful for dev testing.
@code-not-art/core packages/core @code-not-art/core NPM Package Collection of tools to simplify pseudo-random generation and HTML canvas manipulation.
@code-not-art/sketch packages/sketch @code-not-art/sketch Package ReactJS component library to apply procedural art algorithms to HTML canvas.

Quick Start

To get the demo application running on your local machine, after checking out this repository, execute the following steps:

  1. Install dependencies

    This repository is managed by pnpm and the code will run in Node. You will need to install both.

    • Node - Install Instruction - use latest stable version. Note: The Node website provides instructions for using pnpm as part of their install instructions if you choose to. If so, you can skip the separate pnpm instructions.
    • pnpm - Install Instructions
  2. Install code dependencies

    pnpm install
  3. Build all packages

    pnpm build:all
  4. Run Demos App

    pnpm demo

    The application will start, hosting a website at http://localhost:5173. If the default port is in use, the console will print the actual running location of the app.

    Refer to the Demos Readme for instructions on using and modifying the demo applcation.

About

TypeScript framework for interactive generative-art development

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages