README

Exhibition website built on Kirby
CSS powered by Tailwind

Swarm is an exhibitions website builder for Designers, Artists, and Visual Creators to showcase works online. Open-source and powered by Kirby 4. You can learn more about Kirby at getkirby.com

Features

Create a website for a group exhibition, upload work, and share it with the world. Let participants register, create, and publish their projects independently (perfect for showcasing student work at end-of-year exhibitions) or manage everything yourself. Add exhibition details on the About page, include external links, and publish your site!

Simple content management — Powered by Kirby, accessible at yourwebsite.com/panel
Project page — Add project name, title, description, images, videos, and external links
User registration — Allow (or disallow) participants to sign up and upload their work
Customisable design — Set background and text colors, upload a favicon and OG image
Project categories — Organise exhibition works with custom categories
SEO management powered by Kirby SEO
CSS powered by Tailwind CSS

Installation

Web server

Download latest pre-built release in the Releases section.
Extract it and upload the contents to the web server you want to run it on.
Go to /panel and follow the installation instructions.
Upload and share your work!

Requirements

PHP 8.2 or higher
A webserver
Projects to share!

Local configuration

Download the zip archive with the copy of this repository, extract it, and run composer install within the project root directory. The easiest way to run Kirby locally is to use PHP's built-in server with Kirby's router.

php -S localhost:8000 kirby/router.php

Get more information at Kirby website

Composer

composer create-project danil-vladimirov/swarm-kirby-exhibition-website

Tailwind CSS

Make sure that you have Node.js installed on your machine.

First, install Tailwind dependency:

npm install

Use watch to observe changes and generate a CSS file on every change:

npm run watch

Use build to generate a final minified CSS file:

npm run build

License

Swarm is essentially a theme for Kirby 4 — built to make the most of Kirby’s flexibility. It follows the same licensing terms as Kirby 4, outlined in the Kirby End User License Agreement. Kirby 4 is not free software. You can use it for evaluation, but to run it on a live site, you’ll need to purchase a license from getkirby.com.

Everything in this repository (apart from Kirby’s core code and Kirby SEO plugin) is open-source under the MIT License. That means you’re free to modify and share it, as long as you include the original license and copyright notice.

Kirby also offers free licenses for students and select educational projects. Learn more at Kirby website.

Credits

Kirby for the CMS
Tailwind CSS for the CSS framework
Kirby SEO for SEO management plugin

Designed and developed by @danil-vladimirov

danil-vladimirov / swarm-kirby-exhibition-website

Maintainers

Details