https://github.com/studioespresso/craft-craftnet-cp
Very basic api.craftcms.com integration for the Craft control panel
https://github.com/studioespresso/craft-craftnet-cp
craft-plugin craft3 craftcms
Last synced: 10 months ago
JSON representation
Very basic api.craftcms.com integration for the Craft control panel
- Host: GitHub
- URL: https://github.com/studioespresso/craft-craftnet-cp
- Owner: studioespresso
- Created: 2018-09-03T05:40:13.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2019-03-04T18:30:17.000Z (over 7 years ago)
- Last Synced: 2024-04-09T13:23:38.171Z (about 2 years ago)
- Topics: craft-plugin, craft3, craftcms
- Language: PHP
- Size: 43.9 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Craftnet CP plugin for Craft CMS 3.x
Basic craftnet integration with a CP interface and command line tools.
Note that I made this mostly for myself and that future development will take place if and when I need it. Issues and PR's will be handled on a best-effort basis.
## Requirements
This plugin requires Craft CMS 3.0.0-beta.23 or later.
## Installation
To install the plugin, follow these instructions.
1. Open your terminal and go to your Craft project:
cd /path/to/project
2. Then tell Composer to load the plugin:
composer require studioespresso/craftnet-cp
3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Craftnet CP.
## Configuring Craftnet CP
You can manage the following settings in your `craftnet-cp.php` file:
- username (optional, also available as setting in CP)
- token (optional, also available as setting in CP)
- plugins (required, contains `handle => label` for each of your plugins.)
- displayNotes (optional, displays notes below plugin license info)
'you@myawesomeplugins.com',
'token' => '5tmukfu4x2ld8xm1619oJy8klw17fvDsXsDDft8nk'
'plugins' => [
'plugin-handle' => 'Plugin Label',
],
'displayNotes' => true
];
## Console Commands
You can add licenses individually or in bulk from the command line.
### craftnet-cp/license/generate
```
// Generate a single license
./craft craftnet-cp/license/generate --email=customer@company.com --plugin=my-plugin-handle
// Generate a single license with more details
./craft craftnet-cp/license/generate --email=customer@company.com --plugin=my-plugin-handle --edition=free --expirable=true --notes="Things to note." --privateNotes="Things to note."
// Generate multiple licenses
./craft craftnet-cp/license/generate --email=customer@company.com --plugin=my-plugin-handle --count=3
```
- The `edition` attribute defaults to `standard`
- The `expirable` attribute defaults to `false`
- The `count` attribute defaults to `1`
### craftnet-cp/license/import-csv
Add licenses in bulk via a CSV file.
```
./craft craftnet-cp/license/import-csv --file="/path/to/file.csv"
```
CSV files can include the following column headers:
- plugin
- email
- count
- edition
- expirable
- notes
- privateNotes
## Functionality
- Generate one or more licenses for a plugin
- List all sold and generated licenses
Brought to you by [Studio Espresso](https://www.studioespresso.co)