readme.md

Boost Note for Teams

We've developed a collaborative workspace app called "Boost Hub" for developer teams.

It's customizable and easy to optimize for your team like lego blocks and even lets you edit documents together in real-time!

https://boostnote.io/

A Polished Notes App with GitHub Flavored Markdown

for macOS, Windows, Linux, iOS, and Android

BoostNote.next is a renewal of the Boostnote app.

Latest releases

• Web app (note.boostio.co)
• Desktop app (macOS, Windows, Linux)
• iOS app in the App Store
• Android app in Play Store

Roadmap

Boost Note Roadmap 2020

Authors & Maintainers

• Rokt33r
• ZeroX-DG
• Flexo

Community

• Facebook Group
• Twitter
• Slack Group
• Blog
• Reddit

Development

Folder structure

• android : Android app project. Please open with Android Studio.
• 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.
• ios : iOS app project. Please open with XCode.
• src : Source code.

Build

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

Web app

# Install dependencies
npm i

# Run webpack and open browser
npm run dev

Electron app

# Install dependencies
npm i

# 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.

Mobile app

• Android (beta)
• iOS (beta)

License

GPL-3.0 © 2020 BoostIO