https://github.com/putyourlightson/craft-spark-module
A real-time, template-driven hypermedia framework for Craft CMS.
https://github.com/putyourlightson/craft-spark-module
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-module
- Owner: putyourlightson
- License: mit
- Created: 2024-11-01T14:32:03.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-11-05T21:51:44.000Z (over 1 year ago)
- Last Synced: 2024-11-29T11:07:52.742Z (over 1 year ago)
- Language: JavaScript
- Size: 86.9 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[]((https://packagist.org/packages/putyourlightson/craft-spark-module))
[](https://packagist.org/packages/putyourlightson/craft-spark-module)
# Spark Module for Craft CMS
This module provides the core functionality for the [Spark plugin](https://github.com/putyourlightson/craft-spark), a real-time, template-driven hypermedia framework for [Craft CMS](https://craftcms.com/). If you are developing a Craft plugin/module and would like to use Spark in the control panel, you can require this package to give you its functionality, without requiring that the Spark plugin is installed.
First require the package in your plugin/module’s `composer.json` file.
```json
{
"require": {
"putyourlightson/craft-spark-module": "^1.0.0-alpha.1"
}
}
```
Then bootstrap the module from within your plugin/module’s `init` method.
```php
use craft\base\Plugin;
use putyourlightson\spark\Spark;
class MyPlugin extends Plugin
{
public function init()
{
parent::init();
Spark::bootstrap();
}
}
```
Then use the Spark function and tags as normal in your control panel templates.
```twig
Search
```
Spark plugin issues should be reported to https://github.com/putyourlightson/craft-spark/issues
The Spark plugin changelog is at https://github.com/putyourlightson/craft-spark/blob/develop/CHANGELOG.md
## 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
Install this package via composer.
```shell
composer require putyourlightson/craft-spark-module:^1.0.0-alpha.1
```
---
Created by [PutYourLightsOn](https://putyourlightson.com/).