Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.93 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.93 KB

Bonsai IDE

Bonsai is a cross platform IDE aimed at research into Programming as Problem-Solving, and cards-based user interfaces. Bonsai is a Japanese art form that uses trees grown in containers as aesthetic expressions of wabi-sabi; the acceptance of transience and imperfection. Wabi-sabi encompasses the concept of beauty as "imperfect, impermanent, and incomplete". Bonsai IDE allows users to gather transient knowledge across multiple sources, build and rebuild software, and engender knowledge and awareness in a workspace that is constantly changing.

Quick start

The only development dependency of this project is Node.js, so just make sure you have it installed. Then type few commands known to every Node developer...

git clone https://github.com/nelsonni/bonsai.git
cd bonsai
npm install
npm start

... and boom! You have a running desktop application on your screen.

Build Instructions

Packaging Electron apps for release is platform-specific and requires the use of additional scripts.

  1. Run the following command to install electron-packager such that the package will appear in devDependencies:
  • npm install electron-packager --save-dev
  1. Run the following command to install electron such that the package will appear in devDependencies:
  • npm install electron --save-dev
  1. Run the following command from within the project directory:
  • electron-packager . bonsai --platform=all --arch=x64

Note: For the electron-packager command, the --platform can be set to all, or one or more of: darwin for MacOS, linux for Linux, win32 for Windows, or mas. Possibly need to include the --overwrite command if previous builds have already been generated.

Contributors

Nicholas Nelson (@nelsonni)
Brandon Dring (@El_Dringo_Brannde)
Lauren Gastineau (@laurengastineau)