Skip to content
This repository has been archived by the owner on Jul 6, 2021. It is now read-only.

Latest commit

 

History

History
81 lines (65 loc) · 4.83 KB

README.md

File metadata and controls

81 lines (65 loc) · 4.83 KB
Raw

💨 This repository has been moved to GitLab.

Please check out the current version at: https://gitlab.com/Openki/Openki

Openki Build Status CII Best Practices Maintainability

Platform for open education – Free software built with Meteor.js

An interactive web-platform to provide barrier-free access to education for everyone. It is a simple to use open-source tool for local, self-organized knowledge-exchange: As a foundation for mediating non-commercial education opportunities, as interface between people who are interested in similar subjects, and as an instrument which simplifies the organization of “peer-to-peer” sharing of knowledge.

arrow diagram showing connection between individuals, comunities, event-locations and calendars

Beside the longterm public installations, Openki can be used at unconferences, BarCamps as well as in democratic schools and participatory festivals.

read on...

(★ Star us if you like the idea)

Features

  • 📝 Easily propose courses and events
  • 🔍 Fulltext-search them
  • 💬 Simple discussion-board
  • 💻 Infoscreen: Live-views with upcoming events for big and small screens (Wiki)
  • 📟 Frame-URLs to dynamically embed views into other pages (Wiki)
  • 🐱 Categories with sub-categories
  • 🚪 Regions- and room-system
  • 🎓 Extendable participant roles
  • 💮 Groups-, community- and program-system and -filters
  • 📅 Calendar and iCal exports (Wiki)
  • 🔑 Single-Sign-on (OpenID/OAuth: Github, Facebook, g+)
  • 📱 Responsive design: Mobile, tablet and desktop computers
  • 🉐 I18n: In-browser-GUI for crowdsourced, live translation (using meteor-messageformat)
  • ✉️ Email notifications

Intended features

  • ⬜ White-labeling for groups, locations and regions
  • 📂 File upload for course-documentation
  • 🔐 Privacy settings and security
  • ✔️ Voting-/polling-system, fix-a-date schedules
  • 📫 Privat messaging
  • 📛 OpenBadges
  • 👻 Customizability
  • 🎱 Connection to SocialNetworks APIs
  • 📱 Smartphone App

Contribution

All submissions are welcome. To submit a change, fork this repo, commit your changes, and send us a pull request.
In the interest of having a open and welcoming environment for everyone, we agreed on our Code of Conduct. By participating in this project you agree to abide by its terms.

Installation (Linux, OSX and Windows)

  • To install Meteor locally, run: curl https://install.meteor.com | sh (or download the installer for Windows)

  • Download and unzip or git clone https://github.com/Openki/Openki.git Openki into /some/path.

  • cd /some/path/Openki

  • meteor npm install

  • Run meteor npm run dev

  • Browse to localhost:3000 -> done. (admin: greg/greg, any other visible user has pwd greg as well)

  • There are other actions you can use with meteor npm run: app-test and js-lint.

Documentation

  • The technical documentation is here on Github in the 📖 Wiki
  • More documentation can be found on our blog

License

  • AGPL – GNU Affero General Public License (for the sourcecode)
  • For all course contents and descriptions (if not differently indicated): Creative Commons BY-SA
  • For all testing-events descriptions (server/data/testing.events.js): Creative Commons BY-NC-SA