https://github.com/sebkolind/volcano
🌋 A micro flat-file blog and website constructor.
https://github.com/sebkolind/volcano
blog-engine flat-file micro micro-library microlibrary php php-library php8
Last synced: 10 months ago
JSON representation
🌋 A micro flat-file blog and website constructor.
- Host: GitHub
- URL: https://github.com/sebkolind/volcano
- Owner: sebkolind
- License: mit
- Created: 2017-08-15T12:49:04.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T20:29:15.000Z (over 1 year ago)
- Last Synced: 2025-05-16T01:11:40.676Z (about 1 year ago)
- Topics: blog-engine, flat-file, micro, micro-library, microlibrary, php, php-library, php8
- Language: PHP
- Homepage:
- Size: 553 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Volcano 🌋
A micro flat-file blog and website constructor.
## Features
- No database
- Fast
- Easy to use
- You write your content in beautiful Markdown
- Great with custom designs
## Requirements
- PHP 8.0.0 or higher
- Support for `mod_rewrite` ([how to set up](https://www.digitalocean.com/community/tutorials/how-to-set-up-mod_rewrite))
## Getting Started
```bash
cd ~/path/to/project
composer require sebastianks/volcano
# IMPORTANT
# Copy a slim starter template bundled with Volcano.
cp -r vendor/sebastianks/volcano/setup/* .
```
Volcano will now serve your app from `/site/theme/index.php` which at it's lightest can be as slim as:
```php
render();
```
That is Volcano at it's barebones. A more realistic real-life example can be found [in the Wiki](https://github.com/sebastianks/volcano/wiki/The-Simple-Starter).
## What's next?
You just created your first app with Volcano🎉 Now you can go ahead and make a beautiful theme, start composing some content or something else you fancy. It's all up to you.
A couple of resources if you need some information and/or inspiration:
- Read the [Wiki](https://github.com/sebastianks/volcano/wiki/Home%F0%9F%8C%8B). It's short and will get you started in no time.
- Volcano has a well-documented codebase. Reading it will give you everything there is to know about Volcano.
- Creating a blog? Try out the official [Blog](https://github.com/sebastianks/volcano-blog-template) template and start blogging right away.