https://github.com/hughbris/grav-plugin-gyst
Get Your Sheet Together! Export Grav form data as a row in a cloud spreadsheet,
https://github.com/hughbris/grav-plugin-gyst
google-sheets grav plugin
Last synced: 8 days ago
JSON representation
Get Your Sheet Together! Export Grav form data as a row in a cloud spreadsheet,
- Host: GitHub
- URL: https://github.com/hughbris/grav-plugin-gyst
- Owner: hughbris
- License: mit
- Created: 2019-11-05T11:43:55.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-04-19T19:36:42.000Z (about 2 years ago)
- Last Synced: 2025-03-31T03:51:44.585Z (about 1 month ago)
- Topics: google-sheets, grav, plugin
- Language: PHP
- Homepage:
- Size: 68.4 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Gyst Plugin
The **Gyst** (Get Your Sheet Together) Plugin is for [Grav CMS](http://github.com/getgrav/grav).
It allows data [submitted from a form](http://github.com/getgrav/grav-plugin-form) to be saved as a row in a cloud spreadsheet. _Currently only Google Sheets is supported._
It was originally called Sheet Storm. Github redirects the old permalink, so there should be very little inconvenience or even evidence of the old name.
## Installation
Installing the Gyst plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
> After either installation method, it is important to install the libraries required for your cloud spreadsheet provider. Presently only Google Sheets is supported, so please move into your plugin folder in a shell and type: `composer require google/apiclient:^2.0`. _(You need [PHP composer](https://getcomposer.org) for that to work, too.)_
### Dependencies
This plugin requires the [Form plugin](https://github.com/getgrav/grav-plugin-form) to provide anything useful.
### GPM Installation (Preferred)
The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's terminal (also called the command line). From the root of your Grav install type:
bin/gpm install gyst
This will install the Gyst plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/gyst`.
### Manual Installation
To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `gyst`. You can find these files on [GitHub](https://github.com/hughbris/grav-plugin-gyst) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).
You should now have all the plugin files under
/your/site/grav/user/plugins/gyst
> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav) and the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-problems) to operate.
### Admin Plugin
If you use the admin plugin, you can install directly through the admin plugin by browsing the `Plugins` tab and clicking on the `Add` button.
## Configuration
Before configuring this plugin, you should copy the `user/plugins/gyst/gyst.yaml` to `user/config/plugins/gyst.yaml` and only edit that copy.
Here is the default configuration and an explanation of available options:
```yaml
enabled: true
providers:
google_sheets:
auth:
path: '/LOCAL_API_KEYFILE_PATH' # configure this
default_id: 'YOUR_DEFAULT_SPREADSHEET_ID' # optional default spreadsheet id for forms without process.sheet_row.spreadsheet
```
Note that if you use the admin plugin, a file with your configuration, and named gyst.yaml will be saved in the `user/config/plugins/` folder once the configuration is saved in the admin.
## Usage
After configuring the plugin, add an action to your forms where you want to store data as a cloud spreadsheet row.
```yaml
process: # parent property, included as context
- sheet_row:
provider: 'google_sheets' # required
spreadsheet: 'YOUR_SPREADSHEET_ID' # optional, defaults to plugin config providers[provider].default_id
sheetname: 'YOUR_SHEET_NAME_CAN_BE_A_TWIG_EXPRESSION' # optional, defaults to form name
fields: ['FIELD1','FIELD2'] # optional, defaults to everything serialisable
# dump: true # mainly for developers/debugging. If not falsey, dumps info about spreadsheet and aborts form and page processing
```
## Credits
I will credit in a later commit #TODO.
This plugin comes out a [discussion on Grav Community Forum](https://discourse.getgrav.org/t/email-form-and-google-sheet/9586).
## To Do
- [ ] Make this better