Skip to content

MintyOrb/knowlo-library

Repository files navigation

For the design and proliferation of knowledge.

Knowlo is a principled, community driven, open source, radically transparent, not-for-profit educational organization driven to optimize access to and proliferation of insight.

Definition:

The Knowlo Library is a principled, open source tool for resource organization, proliferation, and collaboration.

Technical definition:

The Knowlo Library is a Node.js and Vue app using the cross platform Quasar Framework, hosted on Heroku, using Firebase (file hosting, member management) and Neo4j (graph database).

Installation:

  1. Install development dependencies
  2. neo4j
  3. development neo4j db
  4. node.js
  5. git
  6. Clone the repo git clone https://github.com/MintyOrb/knowlo-library
  7. Install npm packages npm install

Development:

Develop as SPA

  1. Start neo4j database server via desktop app or command line
  2. Start node server node server.js
  3. Start Quasar: quasar dev

Develop as Mobile app (via cordova)

Additional installation steps required (details to follow - check out quasar mobile docs)

Once installed, develop on android with npm run m

Develop as Desktop app (via electron)

Instructions to follow - additional installation steps required.

Build

Instructions to follow. Varies by platform.

Deploy

Currently, pushing to the master branch automatically builds the app on heroku.

Contributing

Knowlo is an open source project, collaboration is welcomed- contribution guidelines are under development. For now, reach out to @MintyOrb.

About

The Knowlo Library is a community directed open source tool for resource organization, proliferation, and collaboration.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published