What is a wiki?
A website or database developed collaboratively by a community of users, allowing any user to add and edit content. Example: Wikipedia
Why Matterwiki?
Wiki softwares are too complicated for small teams. Matterwiki is just that, a simple wiki for teams to store and collaborate on knowledge.
Why do you need a wiki?
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.
Features a Simple WYSIWYG Editor
Unlike traditional wiki softwares,
Matterwiki uses a simple WYSIWYG editor. That means,
No complex formatting or structure to follow.
The editing environment you're comfortable in.
WYSIWYG = What you see is what you get.
Screenshots
Simple and Beautiful, the two qualities we maintain on every screen.
Browse Articles
Create or Edit Articles
Read Articles
Browse Revisions
Under the hood
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.
Setup Instructions
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 the auth_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
- At this point, running this with a process manager like PM2 would ensure that this is a background process and doesn't die out. A sample way of starting the app would be: NODE_ENV=production PORT=8000 pm2 start index.js --name "matterwiki"
- 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
- Login with your new admin account and head to the Admin dashboard.
- Create topics and add users to your Wiki.
Some points to note here :
NODE_ENV could take one of these two values, dev or production.
PORT is optional. If it is not specified, then 5000 would be used.
However, if you do not need all this, running npm start should boot up the production build of the app.
Docker instructions are available here.
Subscribe for updates
No spam. Only one email a month. Details about latest updates and features.
