Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ericclack/clojure-wiki

A simple, personal wiki engine -- with Markdown, [[wiki links]], tags, search, page history, change log, and CouchDB storage
https://github.com/ericclack/clojure-wiki

Last synced: 5 days ago
JSON representation

A simple, personal wiki engine -- with Markdown, [[wiki links]], tags, search, page history, change log, and CouchDB storage

Host: GitHub
URL: https://github.com/ericclack/clojure-wiki
Owner: ericclack
License: gpl-3.0
Created: 2017-02-06T12:40:38.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2020-06-20T12:16:20.000Z (over 4 years ago)
Last Synced: 2024-08-01T12:19:28.166Z (3 months ago)
Language: Clojure
Homepage:
Size: 77.1 KB
Stars: 5
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-starred - ericclack/clojure-wiki - A simple, personal wiki engine -- with Markdown, [[wiki links]], tags, search, page history, change log, and CouchDB storage (others)

README

# clojure-wiki

A simple Clojure wiki engine with a CouchDB backend, intended as a personal wiki.
Content is written in Markdown and the engine supports tag navigation and simple word search.

## Prerequisites

Java 1.8+

You will need [Leiningen][1] 2.0 or above installed.

[1]: https://github.com/technomancy/leiningen

CouchDB, tested with version 1.6.1. On a Mac you can install with `brew install couchdb`, on Debian/Ubuntu/etc `sudo apt-get install couchdb`

## Set up

Start up couchdb:

couchdb

Then from the Futon admin system - http://127.0.0.1:5984/_utils/ - create two databases, one for dev, one for testing, and enter their URLs in `profiles.clj`. Here's an example file:

```
;; The profiles.clj file is used for local environment variables, such as database credentials.
;; This file is listed in .gitignore and will be excluded from version control by Git.

{:profiles/dev {:env {:database-url "wiki"
:database-test-url "wiki-test"}}
:profiles/test {:env {:database-url "wiki-test"}}}
```

Now create the database views:

lein setup-db

And for tests:

DATABASE_URL=wiki-test lein setup-db

## Running

If you've not already done so, start CouchDB:

couchdb

To start a web server for the application, run:

lein run

Now browse app: http://127.0.0.1:3000/

## Hints

Add links between pages [[Like This]].

## License