Skip to content

Commit 1cc34ac

Browse files
chore: Init
0 parents  commit 1cc34ac

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+11312
-0
lines changed

.editorconfig

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# Top-most EditorConfig file
4+
root = true
5+
6+
# All files
7+
[*]
8+
charset = utf-8
9+
end_of_line = lf
10+
insert_final_newline = true
11+
trim_trailing_whitespace = true
12+
indent_style = tab
13+
14+
# Markdown files
15+
[*.md]
16+
trim_trailing_whitespace = false
17+
18+
[*.{md,yaml,yml}]
19+
indent_size = 2
20+
indent_style = space

.github/workflows/ci.yaml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: CI
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- main
8+
pull_request:
9+
10+
jobs:
11+
ecs:
12+
name: ECS Check
13+
runs-on: ubuntu-latest
14+
env:
15+
DEFAULT_COMPOSER_FLAGS: "--no-interaction --no-ansi --no-progress"
16+
steps:
17+
- uses: actions/checkout@v4
18+
- uses: shivammathur/setup-php@v2
19+
with:
20+
php-version: 8.2
21+
- run: composer install --prefer-dist --no-progress
22+
- name: Run ecs check
23+
run: |
24+
vendor/bin/ecs --memory-limit=1G --no-progress-bar
25+
rector:
26+
name: Rector dry-run
27+
runs-on: ubuntu-latest
28+
env:
29+
DEFAULT_COMPOSER_FLAGS: "--no-interaction --no-ansi --no-progress"
30+
steps:
31+
- uses: actions/checkout@v4
32+
- uses: shivammathur/setup-php@v2
33+
with:
34+
php-version: 8.2
35+
- run: composer install --prefer-dist --no-progress
36+
- name: Run rector --dry-run
37+
run: |
38+
vendor/bin/rector --memory-limit=1G --no-progress-bar --dry-run
39+
phpstan:
40+
name: PHPStan
41+
runs-on: ubuntu-latest
42+
env:
43+
DEFAULT_COMPOSER_FLAGS: "--no-interaction --no-ansi --no-progress"
44+
steps:
45+
- uses: actions/checkout@v4
46+
- uses: shivammathur/setup-php@v2
47+
with:
48+
php-version: 8.2
49+
- run: composer install --prefer-dist --no-progress
50+
- name: Run phpstan
51+
run: |
52+
vendor/bin/phpstan --memory-limit=1G

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*.log
2+
*.bak
3+
*.DS_Store
4+
*.orig
5+
*Thumbs.db
6+
vendor/
7+
.vscode
8+
.idea
9+
.php_cs.cache
10+
node_modules
11+
docs/.vuepress/dist
12+
composer.lock

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Release Notes for Klaviyo Connect Plus
2+
3+
## 1.0.0
4+
5+
- Initial release

LICENSE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Copyright © Foster Commerce
2+
3+
Permission is hereby granted to any person obtaining a copy of this software
4+
(the “Software”) to use, copy, modify, merge, publish and/or distribute copies
5+
of the Software, and to permit persons to whom the Software is furnished to do
6+
so, subject to the following conditions:
7+
8+
1. **Don’t plagiarize.** The above copyright notice and this license shall be
9+
included in all copies or substantial portions of the Software.
10+
11+
2. **Don’t use the same license on more than one project.** Each licensed copy
12+
of the Software shall be actively installed in no more than one production
13+
environment at a time.
14+
15+
3. **Don’t mess with the licensing features.** Software features related to
16+
licensing shall not be altered or circumvented in any way, including (but
17+
not limited to) license validation, payment prompts, feature restrictions,
18+
and update eligibility.
19+
20+
4. **Pay up.** Payment shall be made immediately upon receipt of any notice,
21+
prompt, reminder, or other message indicating that a payment is owed.
22+
23+
5. **Follow the law.** All use of the Software shall not violate any applicable
24+
law or regulation, nor infringe the rights of any other person or entity.
25+
26+
Failure to comply with the foregoing conditions will automatically and
27+
immediately result in termination of the permission granted hereby. This
28+
license does not include any right to receive updates to the Software or
29+
technical support. Licensees bear all risk related to the quality and
30+
performance of the Software and any modifications made or obtained to it,
31+
including liability for actual and consequential harm, such as loss or
32+
corruption of data, and any necessary service, repair, or correction.
33+
34+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
35+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
36+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
37+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
38+
LIABILITY, INCLUDING SPECIAL, INCIDENTAL AND CONSEQUENTIAL DAMAGES, WHETHER IN
39+
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
40+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
![Header](docs/images/header.png)
2+
# Klaviyo Connect Plus
3+
4+
A [Craft CMS](https://craftcms.com/) plugin for [Klaviyo](https://www.klaviyo.com).
5+
6+
Take advantage of [Klaviyo](https://www.klaviyo.com) to drive more sales with super-targeted, highly-relevant email marketing campaigns.
7+
8+
Connect your Klaviyo account to Craft Commerce to track shoppers during their checkout process and trigger custom events that help you segment shoppers for personalized email notifications.
9+
10+
Then within your Klaviyo account create the appropriate automated "flows" for these events to automate email messages or include your customers into specific campaigns.
11+
12+
__Perfect for recovering abandoned carts, welcoming first-time shoppers, or marketing to purchasers of specific products.__
13+
14+
## Changelog
15+
16+
Visit the [CHANGELOG](https://github.com/FosterCommerce/klaviyo-connect-plus/blob/master/CHANGELOG.md).
17+
18+
## Support
19+
20+
Create a [Github issue](https://github.com/FosterCommerce/klaviyo-connect-plus/issues).
21+
22+
<a href="https://fostercommerce.com" style="display: inline-block; margin-top: 1.25em;" target="_blank">
23+
<img width="160" height="40" src="./docs/images/fostercommerce.svg">
24+
</a>

composer.json

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"name": "fostercommerce/klaviyo-connect-plus",
3+
"description": "Craft Commerce",
4+
"type": "craft-plugin",
5+
"version": "1.0.0",
6+
"keywords": [
7+
"klaviyo"
8+
],
9+
"homepage": "https://fostercommerce.com",
10+
"require": {
11+
"php": "^8.2",
12+
"craftcms/cms": "^5.0.0",
13+
"klaviyo/api": "^7.1"
14+
},
15+
"autoload": {
16+
"psr-4": {
17+
"fostercommerce\\klaviyoconnectplus\\": "src/"
18+
}
19+
},
20+
"extra": {
21+
"handle": "klaviyo-connect-plus",
22+
"name": "Klaviyo Connect Plus",
23+
"developer": "Foster Commerce",
24+
"documentationUrl": "https://github.com/fostercommerce/klaviyo-connect-plus"
25+
},
26+
"require-dev": {
27+
"craftcms/commerce": "^5.0.0",
28+
"craftcms/phpstan": "dev-main",
29+
"craftcms/rector": "dev-main",
30+
"fostercommerce/ecs": "dev-main",
31+
"fostercommerce/rector": "dev-main",
32+
"phpstan/phpstan": "^1.11",
33+
"roave/security-advisories": "dev-latest"
34+
},
35+
"config": {
36+
"allow-plugins": {
37+
"yiisoft/yii2-composer": true,
38+
"craftcms/plugin-installer": true
39+
}
40+
},
41+
"prefer-stable": true,
42+
"minimum-stability": "dev",
43+
"scripts": {
44+
"phpstan": "phpstan --memory-limit=1G",
45+
"ecs:check": "ecs check --ansi --memory-limit=1G",
46+
"ecs:fix": "ecs check --ansi --fix --memory-limit=1G",
47+
"rector:fix": "rector process",
48+
"rector:dry-run": "rector process --dry-run"
49+
}
50+
}

docs/.vuepress/config.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
module.exports = {
2+
title: 'Klaviyo Connect Plus',
3+
description: 'A plugin for Craft CMS. Grow your ecommerce business with smarter email automations.',
4+
themeConfig: {
5+
logo: '/assets/img/icon.svg',
6+
repo: 'FosterCommerce/klaviyo-connect-plus',
7+
displayAllHeaders: true,
8+
}
9+
}
Lines changed: 9 additions & 0 deletions
Loading

docs/.vuepress/styles/palette.styl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
$accentColor = #c7904d
2+
$textColor = #1e2733
3+
$borderColor = rgba(30,39,51,.1)
4+
$codeBgColor = #282c34

0 commit comments

Comments
 (0)