Skip to content

A Clojure backend for managing blog posts and portfolio items created with org-mode. Intended for use with org-blog-mode to enable blogging from emacs.

License

Notifications You must be signed in to change notification settings

lane-s/org-blog

Repository files navigation

org-blog

https://travis-ci.com/lane-s/org-blog.svg?branch=master

org-blog is intended for emacs users that want to blog directly from org-mode.

org-blog currently does not provide a complete blogging solution right out of the box. It is meant for developers or others who are willing to do the (fairly small) amount of work required to deploy the servers. After this work is done, you’ll be able to write and manage posts in emacs. This is great if, like me, you prefer to use emacs for just about everything. For anyone else, it’s probably not worth the trouble.

For now, the system consists of three parts:

  • The backend (this repo): stores, parses, and serves blog posts.
  • org-blog-mode: an emacs package that provides an interface for managing posts.
  • The frontend: Gets parsed posts from the servers and displays them. An example frontend is on the way.

Deploying org-blog

Pull the docker image

docker pull melodylane/org-blog:latest

Create a docker-compose.yaml similar to the one included in this project.

Then:

docker-compose up

The sample docker-compose.yaml will run the backend listening on port 3000 and the database on 5432.

API

See REST API examples to see how the API can be used

Development

Requires Clojure, leiningen, and Docker

Dev Database

Pull the postgres docker image

docker pull postgres

Start the test and dev databases

./start-dev-db.sh

Running Tests

lein test

Running the development server

lein ring server-headless

Build

Creates a standalone jar and a docker image

./build.sh

Run the standalone jar:

java -jar target/org-blog-0.1.0-SNAPSHOT-standalone.jar

License

Copyright © 2019 Lane Spangler

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

About

A Clojure backend for managing blog posts and portfolio items created with org-mode. Intended for use with org-blog-mode to enable blogging from emacs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published