kishuboard 0.1.0

No project description provided

KishuBoard

This is a dash-board extension of Kishu. With the interactive GUI provided by KishuBoard, you can browse, compare and search commits, checkout code/kernel variables to previous commits; branch out etc in a straightforward way.

Getting Started

pypi installation

To install the extension from pypi, execute:

pip install kishuboard

To remove the extension, execute:

pip uninstall kishuboard

starting up via kishuboard

kishuboard

And then you should be able to visit the kishuboard at localhost://5000.

Install from source code:

Note: You will need NodeJS to build the kishuboard, please make sure you have node on your computer, or install it from here.

1. enter the directory of the current file
2. build the NodeJS frontend

npm init # If you are building it from the source code for the first time
npm install # If you are building it from the source code for the first time
npm run build

3. [optional] Install kishu core from source code

source ../.env/bin/activate # activate the virtual environment
pip install ../kishu # install kishu from source code
pip install -r requirements.txt #install other dependencies

4. install kishu board

pip install .

5. run the kishuboard

kishuboard

And then you should be able to visit the kishuboard at localhost://5000.

Development

Dev mode deployment

To run the kishuboard in dev mode, you will need to start the kishuboard server and the kishuboard frontend separately.

1. enter the directory of this readme file
2. start the kishuboard server(backend) in dev mode

source ../.env/bin/activate # activate the virtual environment
cd kishuboard
flask --app server run

3. start the kishuboard frontend in dev mode

cd .. # go back to the directory of this readme file
npm init # If you are building it from the source code for the first time
npm install # If you are building it from the source code for the first time
npm start

And you should be able to visit the kishuboard at localhost://3000.

Release

To build a new release of kishuboard, please refer to RELEASE.md