kaizen

Get better everyday

About

This project uses Feathers. An open source web framework for building modern real-time applications.

This project uses React. An open source front end library.

This project uses Electron

Getting Started

Getting up and running is as easy as 1, 2, 3.

1. Make sure you have NodeJS and npm installed.

2. Install your dependencies

   cd path/to/kaizen
   yarn install
   
   cd path/to/kaizen/ui
   yarn install
   

3. Start your app TODO: Automate this in one script

If you are in the development, then you can start the project by running the front end server and then the elctron app cd path/to/kaize/ui/ yarn start In another terminal run: cd path/to/kaizen yarn dev

Testing

Simply run yarn test and all your tests in the test/ directory will be run.