Standalone app separated from Boost Note for better local space support. See Roadmap.
If you want a collaborative app, please try Boost Note.(https://github.com/BoostIO/BoostNote-App)
dist
: Bundled electron app stuff. All executable and installable of the electron app are generated in this folder. You can generate this bynpm run prepack
,npm run pack
, andnpm run release
scripts.compiled
: Compiled web app resources fromnpm run build
script. The resources are for deploying the web app.electron
: Compiled electron resources fromnpm run build:electron
script. You can run it bynpm start
script. The resources are for packaging the electron app.src
: Source code.
Please copy .env.default
file and create a file named .env
in the root of the project directory, or the build will fail.
# 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.