postleaf: A JavaScript repository from venatoria

Simple, beautiful publishing.

Postleaf is a simple, beautiful, decentralized publishing platform that anyone can use. It's free, open source, and built for the modern publisher.

Created by Cory LaViska

Website: postleaf.org
Twitter: @postleafapp

This software is dedicated to my daughter, Sophia, and my son, Calvin. Chase your dreams, lil’ ones. 💙💚

Alpha testing underway! 🚧

Postleaf is considered feature complete for the 1.0 roadmap, but you may find bugs or see API changes before the stable version is released. This documentation is subject to change as bugs and other issues get ironed out.

Please report bugs to the issue tracker. 🐛

Dependencies

This guide assumes you're installing Postleaf locally for development purposes. Please make sure the following dependencies are installed on your system before continuing:

Node 7 (lower versions have not been tested and are not supported)
npm
Git
SQLite 3
GraphicsMagick

You will also need access to an SMTP server for sending emails. Otherwise, you won't be able to create users, perform password resets, etc. If you don't already have a transactional email service, the folks over at Discourse have put together a great list of email providers — many of which offer free plans.

Installation

Open a terminal and clone the project and default theme:

git clone https://github.com/Postleaf/postleaf.git && cd postleaf
git clone https://github.com/Postleaf/empower-theme.git themes/empower-theme

Make a copy of .env.example and name it .env. Open it and change AUTH_SECRET to a random string to secure your app. Then add your SMTP credentials so email can be sent.
Install dependencies and run the build script:

npm install
gulp build

Now launch the app:

node app.js

At this point, you should be able to see Postleaf running by pointing your browser to http://localhost:3000/. If not, someone in the forum or chat room can probably assist.

Themes

To install more themes, simply add them to the themes directory. There are a couple additional themes located in the main repo.

To create your own theme, start by duplicating the default theme. The source is commented to help you, and there's more info about Dust.js templates in the project wiki.

Support

Please visit the community forum for support. You can also hop onto the chat for assistance.

License

This software is copyrighted. You may use it under the terms of the MIT license. See LICENSE.md for details.

All code is copyrighted by A Beautiful Site, LLC except where noted. Third-party libraries are copyrighted and licensed by their respective owners.

Postleaf is maintained under the Semantic Versioning guidelines and we adhere to them as closely as possible.