sebastianks/volcano

A micro flat-file website and blog constructor.

Maintainers

Details

github.com/sebkolind/volcano

Source

Issues

Installs: 33

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 2

Forks: 2

Open Issues: 4

1.0.0 2021-02-14 10:22 UTC

Requires

Requires (Dev)

MIT c19369efe9af9e575a90094b64161e39cb88a106

This package is auto-updated.

Last update: 2024-03-28 13:06:01 UTC

README

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

Getting Started

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

# Get our App instance
$app = require __DIR__ . '/../../app.php';

# This is where the magic happens 🧙‍♂️
echo $app->render();

That is Volcano at it's barebones. A more realistic real-life example can be found in the Wiki.

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. 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 template and start blogging right away.
  • Need help with anything? Feel free to reach out on Discord.