Open source knowledge base application for Teams(用于团队的开源知识库应用程序)
Clone or download
Pull request Compare This branch is 4 commits ahead, 6 commits behind ziishaned:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bootstrap
config
database
public
resources
routes
storage
tests
.dockerignore
.env.dist
.gitattributes
.gitignore
.travis.yml
LICENSE.md
app.docker
artisan
composer.json
composer.lock
demo.md
docker-compose.yml
docker.md
phpunit.xml
readme.md
server.php
vhost.conf
web.docker

readme.md

OPUS 中文优化版

Opus 是一个记录您的团队是谁,您做什么以及如何做的开源软件。它可以帮助您为团队创建和维护知识库。

优化特性

  • 中文优化
  • Laravel 升级为 5.5
  • 支持中文字符
  • 修复一些 bug

安装

  • 下载源码包 :
    git clone git@github.com:huanghua581/opus-cn.git
  • 复制 .env.dist 创建 .env 文件
  • 安装 Compoer 依赖包
    composer install
  • 执行数据库初始化
    php artisan migrate
  • 创建 application key
    php artisan key:generate
  • 填充初始数据
    php artisan db:seed

初始化登录信息

默认团队: opus
默认邮箱: admin@admin.com
默认密码: admin

原说明文档

Opensource knowledge base application for Teams.

Introduction

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.

Opus

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 spaces 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

  • Run the below command in your terminal:
    composer create-project ziishaned/opus
  • Create .env using .env.dist and populate the relevant information
  • Install the dependencies
    composer install
  • Open the project directory and run the below
    php artisan migrate
  • Generate an application key
    php artisan key:generate
  • Run the database seeder
    php artisan db:seed

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
    • In-app Notification balloon
    • Mentioned in comment notifications
  • Global Search
  • Responsive
  • Upload demo somewhere

Contribution

  • Report issues
  • Open pull request to DEV BRANCH with improvements
  • Spread the word
  • Reach out to me directly at ziishaned@gmail.com or on twitter @ziishaned

License

The license holder is allowed to use the software for free, as long as they don't make money using it. Read more in License