Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.89 KB

README.md

File metadata and controls

46 lines (27 loc) · 1.89 KB

The Slim Framework Markdown-powered Blog

This is a, small, blog application powered by Markdown files with Yaml frontmatter. It uses the Slim Framework to glue everything together, as Slim is a light, nimble, and extremely flexible framework for web-based applications.

It was written as part of a two-part series for the Twilio blog.

Prerequisites

Depending on how you use the application, your prerequisites will differ.

Using Docker Compose

If you're using Docker Compose (I recommend version 2), you only need, naturally Docker Compose, and Docker Engine.

Want to learn the essentials of Docker Compose as quickly as possible? Grab a copy of the book I wrote about it: Deploy With Docker Compose. It's free!

Not Using Docker Compose

If you're not using Docker Compose, then you will need the following:

Usage

To use the application, clone it locally and change into the cloned directory, by running the following commands.

git clone https://github.com/settermjd/slimphp-markdown-blog.git slim-framework-markdown-blog
cd slim-framework-markdown-blog

Running the application

Using Docker Compose

To start the application using Docker Compose, run the command below.

docker-compose up -d

Not Using Docker Compose

If you're not using Docker Compose, you'll have to set up a virtual host in your web server of choice, which is outside the scope of this README.