quiki v0.1.2

quiki

Quiki is an open-source wiki platform built with Node.js and React, and uses a Memoria flat file database. Pages in the wiki are created using the Markdown syntax. This platform is designed for small wikis such as project documentation.

Installing quiki

Run the following command in your terminal:

$ npm install quiki

Start quiki by running:

$ node ./node_modules/quiki/server.js

This will start quiki on the default port of 3001. You can also specify the port to use by defining the PORT environment variable. It's recommended to use a process manager for Node.js such as forever or pm2 to start quiki.

Setting up quiki

The default login credentials are:

Username: admin Password: password

Use these to log in, edit the landing page, change wiki settings, and create additional users.

Developing quiki

You will need to have gulp installed as it's used to build quiki. Run npm install -g gulp, then fork this repo.

All server-side logic is written in the server.js file and in the server folder. All client-side code is written as React.js components in the client folder.

To build for development and listen for code changes, run gulp dev.