Skip to content

sketchbook-js/sketchbook

Repository files navigation

Sketchbook.js

The design tool that lives in your repo.

Github Actions CI build status

Official website

https://sketchbookjs.com

Demo

https://demo.sketchbookjs.com

Getting started

  1. Install the package:

    yarn add -D @sketchbook-js/sketchbook
    
  2. Create the default sketchbook/config.js and sketchbook/example.json files:

    yarn sketchbook init
    
  3. Run on http://localhost:3000/:

    yarn sketchbook start sketchbook/example.json
    

Contributing

Take a look at the roadmap to see what's planned:

https://github.com/orgs/sketchbook-js/projects/1

Ask questions and discuss ideas in the Github Discussions section:

https://github.com/sketchbook-js/sketchbook/discussions

Have a read of the guidelines to start contributing:

https://github.com/sketchbook-js/sketchbook/blob/master/CONTRIBUTING.md


ColonyDB Powered by Vercel