Skip to content

Wilfred/metawiki

Repository files navigation

Metawiki Build Status Dependency Status Coverage Status Code Climate Docker Cloud Build Status

Demo site: http://metawiki-demo.wilfred.me.uk/

This is a proof of concept self-hosting metawiki. It has basic self-editing functionality but no concept of users or history yet.

The backend is a simple node.js application with a JSON REST API. The API design is based on GoCardless's API design guidelines. The frontend is a single page app.

License

Metawiki code is under the AGPLv3 license.

Ouroboros image is under CC-NC-ND license.

Icons are from Icons8 which is CC-BY-ND.

Running the server

# Install the dependencies.
$ npm install -g yarn
$ yarn

# Start a database for the backend.
$ sudo systemctl start mongodb
# if mongo didn't shut down cleanly:
$ sudo -u mongodb bash -c "mongod --repair --dbpath /var/lib/mongodb"

# Populate the database and start the server.
$ yarn run load-db
$ yarn run start

Tests

We have a handful of backend tests. You will need to have a mongodb instance running.

$ export PATH=$PATH:node_modules/.bin
$ npm test

Releases

No releases published

Packages

No packages published