/opus

Open source knowledge base application for Teams

Primary LanguageJavaScriptMIT LicenseMIT

Opus

Opensource knowledge base application for Teams

Opus is a place for your team to document who you are, what you do and how you do it. It helps you create and maintain a knowledge base for your teams. Demo here

Motivation

As companies grow, it becomes difficult to manage and communicate the knowledge across different departments, Opus acts as a single source of truth; a go-to place for the employees to get knowledge. It gives enterprises the power to create anything and everything; from meeting notes, project plans, product requirements, technical documentations, orchestrate processes, work-flows and more.

There are spaces for every team, department or major project. Then employees can create, organize and share knowledge inside their relevant teams and keep work organized. There is a structured hierarchy and powerful search engine to find what you need quickly and easily. Apart from that, templates help creating documents without any hassle and there is PDF and Office Docs generation for the ease of sharing.

Features

  • Create manage Wikis (group of knowledge pages)
  • Create nested pages inside wikis
  • Manage wikis and pages by categories and tags
  • Invite employees by email
  • Powerful ACL to assign different roles and permissions to employees.
  • Slack notifications for the wiki updates
  • Mark wikis and pages as favorite
  • Watch wiki/pages to get notified
  • In-app notifications
  • Discussions using comments
  • Create reusable page templates
  • Search across the knowledge base
  • ..and more

Requirements

  • PHP 7.0+
  • MySQL 5+

Installation

  • Clone the repository 
    git clone https://github.com/zeeshanu/wiki.git
  • Create .env using .env.example and populate the relevant information
  • Open the project directory and run the below 
    php artisan migrate
  • If you would want dummy data for testing purposes, run the seeder as follows 
    php artisan db:seed
  • Install the dependencies 
    composer install

Todo

  • Access Control
    • Create and Update User Roles
    • Create User Roles
    • Assign Roles to Employees
    • Invite employees by email
  • Wikis
    • Create Spaces (Group of Wikis)
    • Create Wikis inside Spaces
    • Update and Delete Wikis
    • Create Pages inside Wikis
    • Syntax Highlighting for Code
    • Update and Delete Pages
    • Hierarchical Page Trees
    • Rearrange Pages in Wikis
    • Mark Pages as Favorite
    • Leave Comments
      • Mention Team Members
      • Add Emojis
    • Watch Wikis to get notified for updates
    • Save pages in Read List (Like Watch Later in Youtube)
    • Add Tags to Pages
    • List all Pages available in a tag
  • Team Dashboard (Monitor Team Activity)
  • User Dashboard (Monitor User Activity)
  • Export Documents
    • Export Page as PDF
    • Export Page as MS Word File
  • Notifications
    • Add slack integration in team
    • Notify on slack
    • Set Notification Preferences in Profile
    • In-app Notification balloon
    • Notifications by email
    • Mentioned in comment notifications
  • Templates
    • Create Templates
    • Populate Wiki by Template (Dropdown on Create Wiki Page)
  • Global Search
  • Responsive
  • Upload demo somewhere

Contribution

License

MIT © Zeeshan Ahmed