https://github.com/wilfred/metawiki

Proof-of-concept self-hosting metawiki
https://github.com/wilfred/metawiki

javascript metawiki self-hosted wiki

Last synced: 2 months ago
JSON representation

Proof-of-concept self-hosting metawiki

• Host: GitHub
• URL: https://github.com/wilfred/metawiki
• Owner: Wilfred
• Created: 2014-03-12T22:13:55.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T15:52:18.000Z (about 2 years ago)
• Last Synced: 2024-04-14T12:30:23.490Z (9 months ago)
• Topics: javascript, metawiki, self-hosted, wiki
• Language: JavaScript
• Homepage: http://metawiki-demo.wilfred.me.uk/
• Size: 2.2 MB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Metawiki [![Build Status](https://travis-ci.org/Wilfred/metawiki.svg?branch=master)](https://travis-ci.org/Wilfred/metawiki) [![Dependency Status](https://david-dm.org/wilfred/metawiki.svg)](https://david-dm.org/wilfred/metawiki) [![Coverage Status](https://coveralls.io/repos/Wilfred/metawiki/badge.svg)](https://coveralls.io/r/Wilfred/metawiki) [![Code Climate](https://codeclimate.com/github/Wilfred/metawiki/badges/gpa.svg)](https://codeclimate.com/github/Wilfred/metawiki) [![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/wilfred/metawiki)](https://hub.docker.com/r/wilfred/metawiki)

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](https://github.com/gocardless/http-api-design/blob/master/README.md). The

frontend is a single page app.

## License

Metawiki code is under the AGPLv3 license.

Ouroboros image

is

[under CC-NC-ND license](https://www.flickr.com/photos/vaxzine/3389513720).

Icons are from Icons8 which is [CC-BY-ND](https://icons8.com/license/).

## 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

```