Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Latest commit

 

History

History
56 lines (37 loc) · 2.68 KB

README.md

File metadata and controls

56 lines (37 loc) · 2.68 KB

bovine

Just an online learning system

bovine was created with a simple goal; to create an online learning system that works. A virtual classroom with all the bull power, none of the feces. bovine will provide a wide range of features that will enable teachers and instructors to stop worrying about management and syntax issues and get back to doing what their good at.

bovine is aimed towards a system that will allow for easy integration of modules and stylesheets through npm, while providing a simple, user-friendly interface that anyone can work with comfortably. Upon initial startup, bovine will search for existing configuration objects in the database. If none are found, a new configuration object is created to help you get started.

IMPORTANT: Development hiatus

As the project does not seem to have much wind behind it's sails and the demand for it seems to be virtually nonexistent, I am announcing an indefinite hiatus of the project.

As the sole contributor, I have other projects I would like to focus on that may have more demand and be more useful for the general populus, which is the main goal of my projects-- to create free, open-source projects that can be help others.

Shall any additional contributors wish to push code to this repository, I will graciously accept it. If another developer would like to become the maintainer of the project, I may consider transferring ownership if it means the project will excel. At the time of writing, I am unsure of future involvement in the project.

installation

To install bovine, simply run npm install bovine. Once installed, the server can be started with npm start or through node app.js

When run using node app.js, bovine will accept the launch parameters host ([--host | --h | -h hostname]), port ([--port | --p | or -p port]), environment ([--env | --e | -e { 0 for production, 1 for development, 2 for testing } ])

features

  • versioned configurations management
  • class management system
  • role-based rendering
  • sleek, user-friendly design
  • plugins (front-end)

roadmap (planned features)

NOTE: bovine is still in development. Much more development is necessary before it can be considered stable.

  • better query limiting and search support
  • cluster/loadbalancing support
  • middleware
  • separation of main components into middleware
  • extensive configuration management
  • API and theming system
  • better documentation

contributing

Please see the all-knowing CONTRIBUTING file

license

bovine is licensed under the MIT License. For more information, please see LICENSE