Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boostio/boostnote.next-local
Boost Note next local spaces is lightspeed workspace for developers
https://github.com/boostio/boostnote.next-local
electron markdown markdown-editor markdown-to-html markdown-viewer note-taking note-taking-app
Last synced: about 1 month ago
JSON representation
Boost Note next local spaces is lightspeed workspace for developers
- Host: GitHub
- URL: https://github.com/boostio/boostnote.next-local
- Owner: BoostIO
- License: other
- Created: 2021-08-02T06:42:25.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-07-17T13:21:08.000Z (over 2 years ago)
- Last Synced: 2024-04-14T03:00:21.395Z (7 months ago)
- Topics: electron, markdown, markdown-editor, markdown-to-html, markdown-viewer, note-taking, note-taking-app
- Language: TypeScript
- Homepage:
- Size: 75.1 MB
- Stars: 120
- Watchers: 5
- Forks: 20
- Open Issues: 30
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Boost Note Local
Standalone app separated from Boost Note for better local space support. See [Roadmap](https://github.com/BoostIO/BoostNote.next-local/discussions/43).
> ## Boost Note
>
> If you want a collaborative app, please try Boost Note.(https://github.com/BoostIO/BoostNote-App)
>
> 
>
>
A collaborative real-time markdown note app for developer teams
>
> ## Support Platform
>
> - [Web app](https://boostnote.io)
> - [Desktop app](https://boostnote.io/#download)
> - [iOS app](https://apps.apple.com/gb/app/boost-note-mobile/id1576176505)
> - [Android app](https://play.google.com/store/apps/details?id=com.boostio.boostnote2021)
## Authors & Maintainers
- [Rokt33r](https://github.com/rokt33r)
- [Komediruzecki](https://github.com/Komediruzecki) ([buy me a coffee](https://www.buymeacoffee.com/komediruzecki))
## Community
- [Discussions Forum (New!)](https://github.com/BoostIO/BoostNote.next-local/discussions)
- [Twitter](https://twitter.com/boostnoteapp)
- [Slack Group](https://join.slack.com/t/boostnote-group/shared_invite/zt-cun7pas3-WwkaezxHBB1lCbUHrwQLXw)
- [Blog](https://medium.com/boostnote)
- [Reddit](https://www.reddit.com/r/Boostnote/)
## 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.
### 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
```sh
# 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.
## License
[GPL-3.0 © 2016 - 2021 BoostIO](./LICENSE.md)