BoostNote.next local

<div align="center"> <h1><img src="static/logo.svg" width="30"> Boost Note Local</h1> </div>

Standalone app separated from Boost Note for better local space support. See Roadmap.

Boost Note

If you want a collaborative app, please try Boost Note.(https://github.com/BoostIO/BoostNote-App)

<h2 align='center'>A collaborative real-time markdown note app for developer teams</h2>

Support Platform

• Web app
• Desktop app
• iOS app
• Android app

Authors & Maintainers

• Rokt33r
• Komediruzecki (buy me a coffee)

Community

• Discussions Forum (New!)
• Twitter
• Slack Group
• Blog
• Reddit

Development

Folder structure

• dist : Bundled electron app stuff. All executable and installable of the electron app are generated in this folder. You can generate this by npm run prepack, npm run pack, and npm run release scripts.
• compiled : Compiled web app resources from npm run build script. The resources are for deploying the web app.
• electron : Compiled electron resources from npm run build:electron script. You can run it by npm start script. The resources are for packaging the electron app.
• src : Source code.

Prerequisites

• Node.js 16.x — newer versions are not supported

shCopy
nvm install 16
nvm use 16

Build

Please copy .env.default file and create a file named .env in the root of the project directory, or the build will fail.

Electron app

shCopy
# Install dependencies
npm install

# Run webpack
npm run dev:webpack

# Run electron (You have to open another terminal to run this)
npm run dev:electron

For Windows users, If npm run dev:electron doesn't spawn an electron window, please try again after removing %APPDATA%\electron directory.

License

GPL-3.0 © 2016 - 2021 BoostIO