Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.66 KB

README.md

File metadata and controls

60 lines (39 loc) · 1.66 KB

Diary

Diary is an open-source tent application designed to manage and edit Essay posts (long-form text). Those can later be consumed by any app supporting this post type. This includes Reevio: an Essay-based bloging app.

Installation

Prerequisites

First things first, let's install a few dependencies for Diary to run properly. Feel free to ignore this part if you already have node, npm and coffee on your machine.

The following instructions will guide you throughout the installation procedure on Ubuntu.

  1. NodeJS + NPM

    sudo apt-get update
sudo apt-get install -y python-software-properties python g++ make
sudo add-apt-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs

  2. CoffeeScript, we'll use NPM to install this one.

    sudo npm install -g coffee-script

Diary

We're now ready to download and run Diary itself.

  1. Retrieve the Diary source code from GitHub.

    git clone https://github.com/BenjBouv/diary.git

  2. Move into the folder that you just cloned the source in, and run the following command to install all the necessary NPM packages.

    sudo npm install

  3. Rename the sample config file config.coffee.example into config.coffee. The default port for diary to run on is 1337, but feel free to edit this config file to change this setting.

    mv config.coffee.example config.coffee

  4. Everything's now ready for us to run the app.

    coffee diary.coffee

License

Diary is made available under the GPLv3 license.