Skip to content

Development

Guidelines for working on reality

Set Up
#

Clone repository, install dependencies, and run docs site and Playroom.

gh repo clone kalidao/reality
yarn
yarn dev

Adding Components
#

Scaffold a new component:

yarn gen:component

Export from src/index.ts to make available:

export { ComponentName } from './components'

Adding Icons
#

Add a .svg file to icons and run:

yarn gen:icons

All files in the icons directory are automatically converted to React components and exported for use. Generated icons should follow a 24x24 bounding box.

Publishing New Versions
#

Create a new release on GitHub with a tag that follows semantic versioning. Publishing a release triggers a workflow for building, testing, and pushing to npm.

Don’t work at Kali?
#

Please consider this project read-only. We’re happy for you to follow along with our work, copy it, fork it, ask us questions on Twitter, etc. but we’re also wanting to minimise the overhead of managing contributions.

Edit on GitHub