Matterwiki

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1.8 KiB

Raw Blame History

People use it to store documentation, notes, culture guidelines, employee onboarding content and everything else they want to.

Setup Instructions:

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
run node index
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.

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.

Like it?

⭐ this repo

Found a bug?

Raise an issue!

Want to contribute?

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.