Bonsai Browser

Web-browser for research that helps programmers think clearly
Website »

Releases · Report Bug · Request Feature

Getting Started

Prerequisites

• nodejs
  • Bonsai Browser has been tested and works with node version 16.15.1, but it will probably work with other node versions
• yarn
  • Bonsai Browser uses yarn instead of npm

Installation

1. Clone the repo

   git clone https://github.com/Bonsai-Desk/bonsai-browser

2. Navigate to project root

   cd bonsai-browser

3. Install dependencies

   yarn

Usage

• Run Bonsai Browser

hot reloading will work for render threads, but not the main thread

non-packaged builds prepend the toggle shortcut with "Ctrl", so the default is Ctrl+Alt+Space instead of Alt+Space

yarn start

• Build Bonsai Browser

The packaged build will end up in the release folder, and for some platforms, it will include both an installable version and a portable version

yarn package

• configuration

The most recent commits have user accounts disabled by default. This can be controlled by a .env file in the root folder.

The following configuration could be used to enable user accounts and to do notarized builds.

This configuration is also required for previous commits to work at all.

Commits older than 11/29/2021 should work without configuration because user accounts did not exist yet.

USE_ACCOUNT=true
REACT_APP_SUPABASE_URL="https://[app url].supabase.co"
SUPABASE_ANON_KEY="[anon key]"
MIXPANEL_PROJECT_DEV_TOKEN="[mixpanel project dev token]"
MIXPANEL_PROJECT_TOKEN="[mixpanel project token]"
CI=true
APPLE_ID="example@example.com"
APPLE_ID_PASS="[apple id pass]"
GH_TOKEN="[github token]"
DEBUG=false

Contributing

Bonsai Browser is no longer being actively developed, but contributions are welcome

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Join the Discord server