Skip to content
This repository has been archived by the owner on Feb 3, 2021. It is now read-only.

Postleaf/postleaf

Repository files navigation

Postleaf

Simple, beautiful publishing.

Postleaf on a laptop, tablet, and phone

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

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

Requirements

  • Node 7
  • SQLite 3
  • GraphicsMagick

Download

This is the development repo! You'll need to build Postleaf using the instructions below before running it.

Contributing

Postleaf uses NPM to manage dependencies and Gulp as its task runner. To contribute to this project, you'll need to clone the repository and install the required development tools listed below.

  • Node
  • Gulp (Install using npm install -g gulp-cli)

Please read through our contributing guidelines.

Building

Once you have the necessary development tools installed:

  1. Open a terminal
  2. Navigate to the root directory of your cloned repo
  3. Run the following command:
npm install
gulp build

This will generate all the assets you need to run Postleaf.

Using Gulp

  • Use gulp build to build all assets.
  • Use gulp clean to remove all assets.
  • Use gulp help to see all available tasks.

Testing

You can run Postleaf using the following command:

node app.js

Then open https://localhost:3000 in your browser.

Versioning

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

License

©2016 A Beautiful Site, LLC

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.

Support

Please visit the community forum for support.


“The starting point of all achievement is desire.” — Napoleon Hill