mirror of
https://github.com/BoostIO/BoostNote-App.git
synced 2024-10-03 23:57:47 +03:00
Boost Note is a document driven project management tool that maximizes remote DevOps team velocity.
agile-developmentboostnotedeveloper-toolsdevopsdocumentation-toolelectronhacktoberfesthacktoberfest2021markdownnotes-for-developerreactstarred-boostio-repostarred-repotypescriptwiki
.github/workflows | ||
.storybook | ||
android | ||
build-utils | ||
cloud-static | ||
docs | ||
ios | ||
macOs | ||
mobile-static | ||
resources | ||
scripts | ||
src | ||
static | ||
test | ||
typings | ||
.babelrc | ||
.env.default | ||
.eslintignore | ||
.eslintrc | ||
.gitignore | ||
.prettierignore | ||
.prettierrc | ||
cloud.html | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
index.html | ||
ISSUE_TEMPLATE.md | ||
jest.json | ||
LICENSE.md | ||
mobile.html | ||
package-lock.json | ||
package.json | ||
readme.md | ||
tsconfig-webpack.json | ||
tsconfig.json | ||
vercel.json | ||
webpack.cloud.config.ts | ||
webpack.config.ts | ||
webpack.mobile.config.ts |
A collaborative real-time markdown note app for developer teams
BoostNote.next is a renewal of the Boostnote app.
Authors & Maintainers
Community
App
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 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.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:cloud
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.