A website or database developed collaboratively by a community of users, allowing any user to add and edit content. Example: Wikipedia
As your company grows it becomes difficult to keep track of all the knowledge in your team. It is difficult to communicate every detail about company policies to new team members. Things get lost in Slack channels. It becomes difficult to keep things in context.
A wiki helps you keep track of all this information. Every article is filed under a topic to keep things organised among departments. Everything is transparent, who made what changes to which document and when.
Wiki softwares are too complicated for small teams. Matterwiki is just that, a simple wiki for teams to store and collaborate on knowledge. People use it to store documentation, notes, culture guidelines, employee onboarding content and everything else they want to.
You need to have Node
and npm
installed on your system.
- Clone this repository
git clone http://github.com/matterwiki/matterwiki
- Run
npm install
- Edit
config.js
(present in the project root) and change theauth_secret
value with any secret phrase. NOTE: This phrase will be used to encode and decode your access tokens. Keep it safe and private - run
npm run build
- run
npm start
- Head to
yoururl.com/#/setup
and create the Admin account.
Replace yoururl.com with your URL. If you're running locally, replace with localhost:5000
7. Login with your new admin account and head to the Admin dashboard.
8. Create topics and add users to your Wiki.
NOTE - Using MySQL
By default Matterwiki uses **Sqlite**, which is a lightweight database management system perfect for an internal wiki. If your team size is huge and you need a concurrent and flexible DBMS you can change the config to use **MySQL**. As we use `Knex` as a query builder all you have to do use MySQL is to change the db object in `knexfile.js` (found the app root directory).
-
First setup MySQL
-
Install mysql from
npm
npm install mysql
-
Change the object from
module.exports = {
client: 'sqlite3',
connection: {
filename: "./db/matterwiki.sqlite"
},
useNullAsDefault: true
}
to
module.exports = {
client: 'mysql',
connection: {
host : '127.0.0.1',
user : 'your_database_user',
password : 'your_database_password',
database : 'myapp_test'
},
useNullAsDefault: true
}
Matterwiki uses a Node.js API with a React.js front-end and Sqlite3 for the database.
As the app is built atop a JSON API, it is simple to integrate your Wiki with your mobile app or blog. For more, read the API documentation.
โญ this repo
Raise an issue!
We welcome all kinds of contributions. It doesn't matter if it's a grammar fix, or some refactoring, or an even an entire UI overhaul. So help us improve Matterwiki for everyone.