search

mwanji / essayist

A blogging app for the tent.io protocol
10 stars 2 forks source link

readme

Essayist

A blogging app for the tent.io protocol. A public instance is available here: http://essayist.mndj.me.

Quick start:

  1. Pre-requisites: Java 1.6+ and Maven
  2. Currently, Essayist depends on a Mavenised version of Migrate4J available only on Github: git clone git://github.com/mwanji/migrate4j-maven.git && cd migrate4j-maven && mvn install
  3. git clone git://github.com/mwanji/essayist.git
  4. Deploy to your favourite servlet container.
  5. http://localhost:8080
  6. Log in with your Tent address, for example https://my_name.tent.is

Configuration

  1. Put a file called essayist.properties in the src/main/resources folder. essayist-example.properties shows what can be configured. essayist-defaults.properties provides a number of defaults.
  2. If using your own database, create an empty database corresponding to the value of db.url

Developers

Metadata post type

http://moandjiezana.com/tent/essayist/types/post/metadata/v0.1.0

Essayist uses a custom post type to store some data, such as the Essay's text as Markdown. It is linked to the Essay (once it has been published) via the mentions.

PropertyRequiredTypeDescription
format Required String Defines the type of content contained in raw. Eg. "markdown".
raw Required String The raw form of the metadata. Eg. the markdown form of an Essay.
statusId Optional String The ID of a status announcing the Essay.