contributing.md

Contributing Guide

Hi! We are really excited that you are interested in contributing to Toolkit. Before submitting your contribution, please make sure to take a moment and read through the following guide:

Repo Setup

# install deps
$ npm run setup

Development and Debugging

# watch and start electron
$ npm run start

You can also debug the electron app by the following two scripts:

# watch web and tsc
$ npm run watch

# start electron
$ npm run start:electron

Deploy

# build the electron
$ npm run package