https://github.com/putyourlightson/craft-spark

A real-time, template-driven hypermedia framework for Craft CMS.
https://github.com/putyourlightson/craft-spark

Last synced: 10 months ago
JSON representation

A real-time, template-driven hypermedia framework for Craft CMS.

• Host: GitHub
• URL: https://github.com/putyourlightson/craft-spark
• Owner: putyourlightson
• License: mit
• Created: 2024-10-12T09:24:16.000Z (over 1 year ago)
• Default Branch: develop
• Last Pushed: 2024-11-05T20:19:05.000Z (over 1 year ago)
• Last Synced: 2024-11-29T11:07:52.644Z (over 1 year ago)
• Language: PHP
• Homepage:
• Size: 164 KB
• Stars: 17
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![Stable Version](https://img.shields.io/packagist/v/putyourlightson/craft-spark?label=stable)]((https://packagist.org/packages/putyourlightson/craft-spark))

[![Total Downloads](https://img.shields.io/packagist/dt/putyourlightson/craft-spark)](https://packagist.org/packages/putyourlightson/craft-spark)



# Spark Plugin for Craft CMS

### A real-time, template-driven hypermedia framework for Craft CMS.

**This plugin is in alpha and its API may change.**

Spark is a free plugin for [Craft CMS](https://craftcms.com/) that allows you to create real-time front-ends driven by Twig templates. It aims to replace the need for front-end frameworks such as React, Vue.js and Alpine.js + htmx, and instead lets you manage state and run logic all within your Twig templates.

With Spark, you have the ability to define state and manipulate the DOM in real-time on the front-end, and modify parts of the DOM with templates rendered on the back-end. Use-cases for Spark are:

- Live searching elements

- Loading more elements / Infinite scroll

- Paginating, ordering and filtering lists of elements

- Submitting forms and running actions

- Pretty much anything to do with reactive front-ends

Spark is lightweight, performant and strongly opinionated about embracing hypermedia and removing front-end complexity. It can be used for anything from simple to complex use-cases.

Read [The Case for Spark](https://github.com/putyourlightson/craft-spark/discussions/2) and join in the discussion.

## Documentation

Learn more and read the documentation at [putyourlightson.com/plugins/spark »](https://putyourlightson.com/plugins/spark)

## License

This plugin is licensed for free under the MIT License.

## Requirements

This plugin requires [Craft CMS](https://craftcms.com/) 5.0.0 or later.

## Installation

To install the plugin, search for “Spark” in the Craft Plugin Store, or install manually using composer.

```shell

composer require putyourlightson/craft-spark:^1.0.0-alpha.1

```

---

Created by [PutYourLightsOn](https://putyourlightson.com/).