Skip to content
This repository has been archived by the owner on May 11, 2023. It is now read-only.

alexwkleung/Blossom-Editor

Repository files navigation

Table of Contents

  1. Blossom Editor
  2. Warnings
  3. Installation (Direct)
  4. Installation (Manual)
  5. ARM
  6. License & Attributions

🌸 Blossom Editor

Platforms Architecture

⚠️ THIS TEXT-EDITOR IS EXPERIMENTAL AND A PROOF OF CONCEPT.

Blossom Editor is a 2000s era inspired text-editor.

Created with:

  • Languages: TypeScript, JavaScript

  • Desktop Framework: Electron

  • Editor: CodeMirror

  • Terminal/Pseudoterminal: xterm.js, node-pty

  • Markdown Parser: Marked

  • Shell Tools: exec-sh

  • Button Icons: Material Symbols

  • Icon: Twemoji 14.0 - Cherry Blossom

Sample screenshots.

one two three four five

Warnings

This text-editor should not be used in production or for daily use.

Prerequisites

To be able to use tabs in Blossom Editor, you must set prefer tabs to always. This is located in your System Preferences:

System Preferences >> General >> Prefer tabs >> "always" when opening documents

Tabs

Without enabling this, your new tabs will become separate windows.

Installation (Direct)

1) Go to Releases on the right hand side of the repository and download the latest version of the .dmg (x64 or arm64 depending on your machine).

2) Open the .dmg located in the root directory and drag the blossom-editor.app into the Applications folder as shown:

dmg

Note: Don't forget to eject the .dmg.

Installation (Manual)

Clone the repository

git clone <SSH/HTTPS>

Change directory

cd Blossom-Editor

Install npm dependencies

npm install

Compile native modules

make rebuild 
#or 
npm run rebuild

Package app and create the .dmg

# x64: 
make package
#or
npm run package

# arm64: 
make package-arm
# or
npm run package-arm

If there are any issues with packaging due to NODE_MODULE_VERSION mismatch, you should run npm rebuild <package>

Open the .dmg located in the root directory and drag the blossom-editor.app into the Applications folder as shown:

dmg

Note: Don't forget to eject the .dmg.

ARM

The arm64 version has not been tested. As a fallback, the x64 version should work under Rosetta 2 translation.

License & Attributions

MIT License.

See NOTICE.md regarding attributions for this project.