https://github.com/settermjd/slimphp-markdown-blog
A small blog module based around PHP's Slim Framework
https://github.com/settermjd/slimphp-markdown-blog
markdown php twilio yaml
Last synced: about 1 year ago
JSON representation
A small blog module based around PHP's Slim Framework
- Host: GitHub
- URL: https://github.com/settermjd/slimphp-markdown-blog
- Owner: settermjd
- Created: 2022-01-08T14:45:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-15T11:09:11.000Z (over 4 years ago)
- Last Synced: 2025-03-23T22:14:23.578Z (about 1 year ago)
- Topics: markdown, php, twilio, yaml
- Language: PHP
- Homepage:
- Size: 370 KB
- Stars: 16
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://www.twilio.com/blog/create-markdown-blog-php-slim-4).
## Prerequisites
Depending on how you use the application, your prerequisites will differ.
### Using Docker Compose
If you're using [Docker Compose](https://docs.docker.com/compose/) (I recommend [version 2](https://docs.docker.com/compose/cli-command/)), 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](https://deploywithdockercompose.com?utm_source=github&utm_medium=readme&utm_campaign=slimphp-markdown-blog). It's **free!**
### Not Using Docker Compose
If you're not using Docker Compose, then you will need the following:
- A [Memcached](https://memcached.org/) server
- [Composer](https://getcomposer.org/) installed globally.
- PHP 7.4+ (ideally version 8) with [the Memcached extension](https://www.php.net/manual/en/book.memcached.php) installed and enabled.
## Usage
To use the application, clone it locally and change into the cloned directory, by running the following commands.
```bash
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.
```bash
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.