Hierarchical wiki built on holochain
Clone or download
Pull request Compare This branch is 2 commits ahead, 1 commit behind JoseOspina:master.

README.md

Fractal-wiki

License: GPL v3 Gitter

Nestable card based wiki built on holochain Prototype of a wiki using a card-based model where cards can be nested in card.

Installation

Prerequiste: Install holochain on your machine. You can install fratal-wiki very simply with this:

hcdev init -cloneExample=fractal-wiki

Usage

To do a test run of fractal-wiki simply type

cd fractal-wiki
hcdev web

you should see something like:

Copying chain to: /home/bootstrap/.holochaindev
...
Serving holochain with DNA hash:QmZYxoxcqgCp6Xf6xVe8ptzPkmH8QMzxqp4r49QYpS2fEF on port:4141

Then simply point your browser to http://localhost:4141 access the UI.

UI Development

Fractal wiki UI is built with Vue. To work on the UI in dev mode you can go into the app directory and run:

npm install
npm run dev

This is configured to proxy the http requests over to the running localhost:4141 holochain instance.

To build the UI so it can be served directly by the holochain instance: cd to the app directory, run

npm run build

this will move the output files to the ui directory.

Tests

To run all the stand alone tests:

hcdev test

Contribute

We welcome pull requests and issue tickets. Find us on gitter to chat.

Contributors to this project are expected to follow our development protocols & practices.

License

License: GPL v3

Copyright (C) 2017, The MetaCurrency Project (Eric Harris-Braun, Arthur Brock, et. al.)

This program is free software: you can redistribute it and/or modify it under the terms of the license provided in the LICENSE file (GPLv3). This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Note: We are considering other 'looser' licensing options (like MIT license) but at this stage are using GPL while we're getting the matter sorted out.