Giter VIP home page Giter VIP logo

boostnote.next-local's Introduction

Boost Note Local

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)

uiimage

A collaborative real-time markdown note app for developer teams

Support Platform

Authors & Maintainers

Community

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

# 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

boostnote.next-local's People

Contributors

rokt33r avatar davy-c avatar butterycrumpet avatar ellekasai avatar komediruzecki avatar sarah-seo avatar zerox-dg avatar dependabot[bot] avatar jhdcruz avatar laudep avatar guneskaan avatar funzin avatar lexar-systems avatar jongkeun avatar georgeherby avatar marilari88 avatar rohjs avatar flexo013 avatar igorsakalo avatar saxc avatar alexandreaguido avatar tetsuya95 avatar matthfaria96 avatar xatier avatar pfftdammitchris avatar pokidokika avatar hsuanxyz avatar ymtdzzz avatar tobifasc avatar siromath avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.