Skip to content

Commit 0309b55

Browse files
author
Marcel Domke
committed
Updated SCAYLE Panel Demo Add-On to version 1.0
- Updated to latest SCAYLE Panel Icon Library - Updated to latest SCAYLE Component Library - Adjusted Readme
1 parent 84f458e commit 0309b55

Some content is hidden

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

48 files changed

+1964
-803
lines changed

‎.editorconfig‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
indent_style = space
8+
indent_size = 4
9+
trim_trailing_whitespace = true
10+
11+
[*.yml]
12+
indent_size = 2
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.env.example‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ENV not exposed to application
2+
CONFIG_SERVER_HOST=demo-add-on.cloud-panel.aboutyou.test
3+
CONFIG_SERVER_PORT=8082
4+
5+
# ENV exposed application (with PANEL_, prefix)
6+
PANEL_ADDON_IDENTIFIER=demo
7+
PANEL_USE_SHADOW_DOM=true

‎.eslintrc.cjs‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
module.exports = {
2+
root: false,
3+
env: {
4+
browser: true,
5+
es6: true,
6+
node: true,
7+
},
8+
plugins: ['unicorn'],
9+
extends: [
10+
'plugin:import/errors',
11+
'plugin:import/warnings',
12+
'plugin:vue/vue3-recommended',
13+
'eslint:recommended',
14+
],
15+
settings: {
16+
'import/resolver': {
17+
typescript: {},
18+
},
19+
},
20+
parser: 'vue-eslint-parser',
21+
parserOptions: {
22+
parser: {
23+
ts: '@typescript-eslint/parser',
24+
},
25+
sourceType: 'module',
26+
},
27+
rules: {
28+
'vue/require-explicit-emits': [
29+
'error',
30+
{
31+
allowProps: false,
32+
},
33+
],
34+
'vue/attributes-order': 'error',
35+
'vue/multi-word-component-names': 'off',
36+
'vue/component-name-in-template-casing': ['error', 'PascalCase'],
37+
'vue/html-self-closing': ['error', {
38+
'html': {
39+
'void': 'always',
40+
'normal': 'always',
41+
'component': 'always'
42+
},
43+
'svg': 'always',
44+
'math': 'always'
45+
}],
46+
'vue/html-closing-bracket-spacing': [
47+
'error',
48+
{
49+
startTag: 'never',
50+
endTag: 'never',
51+
selfClosingTag: 'always',
52+
},
53+
],
54+
// eslint-plugin-import
55+
'import/first': 'error',
56+
'import/order': [
57+
'error',
58+
{
59+
groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object'],
60+
},
61+
],
62+
'import/no-mutable-exports': 'error',
63+
'import/no-unresolved': 'off',
64+
'no-unused-vars': ['off'],
65+
},
66+
};

‎.gitignore‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?
25+
26+
server-ssl/*
27+
!server-ssl/README.md
28+
!server-ssl/generate-ssl.sh
29+
!server-ssl/default.conf
30+
31+
.env
32+
coverage
33+
junit.xml
34+
35+
# ignore types generated from unit tests (src are the vital ones)
36+
auto-imports.d.ts
37+
components.d.ts

‎.lintstagedrc.cjs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module.exports = {
2+
'*.{ts,js,cjs,vue}': [
3+
'bash -c "vue-tsc --noEmit"',
4+
'eslint --fix'
5+
]
6+
}

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 ABOUTYOU / Public
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 54 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,53 @@
1-
## Initial Setup
1+
![scayle-logo-cr](https://cdn-prod.scayle.com/public/media/general/SCAYLE-Commerce-Engine-header.png)
2+
3+
<h1 align="center">
4+
SCAYLE Panel Demo Add-On
5+
</h1>
6+
7+
<h4 align="center">
8+
<a href="https://scayle.dev">Documentation</a> |
9+
<a href="https://www.scayle.com/">Website</a>
10+
</h4>
11+
12+
<p align="center">
13+
The SCAYLE <strong>Panel Demo Add-On</strong> is showcasing how to write an Add-On in combination with the SCAYLE Component Library.
14+
</p>
15+
16+
<p align="center">
17+
<a href="#"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="SCAYLE's *Component Library* is released under the MIT license." /></a>
18+
</p>
19+
20+
21+
## Getting Started
22+
23+
Visit the [Add-On Developer Guide](https://scayle.dev/en/dev/add-on/introduction) to learn more on how to use the Panel icons.
24+
25+
Visit the [Docs](https://scayle.dev) to learn more about our system requirements.
26+
27+
## What is Scayle ?
28+
29+
[SCAYLE](https://scayle.com) is a full-featured e-commerce software solution that comes with flexible APIs. Within SCAYLE, you can manage all aspects of your shop, such as products, stocks, customers, and transactions.
30+
31+
Learn more about [Scayles’s architecture](https://scayle.dev/en/dev/getting-started/introduction) and [commerce modules](https://scayle.dev/en/dev/getting-started/introduction) in the Docs.
32+
33+
34+
## Installation
235

336
Before running the application, you need to configure your hosts file with the add-on's hostname. You'll also need to create an SSL key pair for this domain.
437

538
It's also recommended to install [Volta](https://volta.sh/) in order to use the correct versions of node.js and npm.
639

7-
1. Add `127.0.0.1 {hostname from .env}` (replace everything including the {}) to `/etc/hosts`
8-
2. `npm ci`
9-
3. **Make sure you have `openssl` installed on your computer for this step**. Generate ssl certificates with `npm run generate:ssl`. The domain name (aka hostname) is retrieved from `CONFIG_SERVER_HOST` in `.env`.
40+
```shell
41+
# Add
42+
127.0.0.1 {hostname from .env}` (replace everything including the {}) to `/etc/hosts`
43+
44+
# Execute
45+
npm ci
46+
47+
# !! Make sure you have openssl installed on your computer for this step. !!
48+
# Generate a ssl certificates with the following command. The domain name (aka hostname) is retrieved from `CONFIG_SERVER_HOST` in `.env`.
49+
npm run generate:ssl
50+
```
1051

1152
## Scripts
1253

@@ -31,3 +72,12 @@ Check types: `npm run typecheck`
3172
## Shadow DOM
3273

3374
To inject addon in it's own isolated container we can use [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM). To enable it you must set in .env `PANEL_USE_SHADOW_DOM=true`.
75+
76+
## Other channels
77+
78+
- [LinkedIn](https://www.linkedin.com/company/scaylecommerce/)
79+
- [Jobs](https://careers.smartrecruiters.com/ABOUTYOUGmbH/scayle)
80+
- [AboutYou Tech Blog](https://aboutyou.tech/)
81+
82+
## License
83+
Licensed under the [MIT](https://opensource.org/license/mit/)

0 commit comments

Comments
 (0)