calvin / public-calvin-sf-integration · Commits

Commit 5390ddc367d773f116276c81f2b270e0139fb8b2

Authored by root
0 parents
build: skipped

Initial import

Inline Side-by-side
Showing 42 changed files with 1280 additions and 0 deletions

Too many changes to show.
Reload with full diff Plain diff Email patch

To preserve performance only 42 of 177 files are displayed.

.all-contributorsrc 0 → 100644
  View file @5390ddc
  1 +++ a/.all-contributorsrc
  1 +{
  2 + "projectName": "__replace_me__",
  3 + "projectOwner": "vuestorefront",
  4 + "repoType": "github",
  5 + "repoHost": "https://github.com",
  6 + "files": [
  7 + "README.md"
  8 + ],
  9 + "imageSize": 80,
  10 + "commit": false,
  11 + "commitConvention": "angular",
  12 + "contributors": [],
  13 + "contributorsPerLine": 5
  14 +}
.czrc 0 → 100644
  View file @5390ddc
  1 +++ a/.czrc
  1 +{
  2 + "path": "cz-conventional-changelog",
  3 + "disableScopeLowerCase": false,
  4 + "disableSubjectLowerCase": false,
  5 + "maxHeaderWidth": 100,
  6 + "maxLineWidth": 100
  7 +}
.eslintignore 0 → 100644
  View file @5390ddc
  1 +++ a/.eslintignore
  1 +**/node_modules/**/*
  2 +**/lib/*
  3 +**/tests/*
  4 +packages/composables/nuxt/plugin.js
  5 +packages/theme/_theme
  6 +packages/theme/.nuxt
  7 +packages/theme/middleware.config.js
  8 +packages/theme/nuxt.config.js
.eslintrc.json 0 → 100644
  View file @5390ddc
  1 +++ a/.eslintrc.json
  1 +{
  2 + "root": true,
  3 + "extends": [
  4 + "eslint:recommended",
  5 + "plugin:@typescript-eslint/eslint-recommended",
  6 + "plugin:@typescript-eslint/recommended"
  7 + ],
  8 + "parser": "vue-eslint-parser",
  9 + "parserOptions": {
  10 + "parser": "@typescript-eslint/parser",
  11 + "ecmaVersion": 2021,
  12 + "sourceType": "module"
  13 + },
  14 + "plugins": ["vue", "@typescript-eslint"],
  15 + "env": {
  16 + "browser": true,
  17 + "commonjs": true,
  18 + "node": true,
  19 + "jest": true
  20 + },
  21 + "globals": {
  22 + "Promise": true,
  23 + "process": true,
  24 + "console": true,
  25 + "Set": true,
  26 + "Intl": true
  27 + },
  28 + "rules": {
  29 + "eqeqeq": 2,
  30 + "no-use-before-define": [
  31 + 2,
  32 + {
  33 + "functions": false
  34 + }
  35 + ],
  36 + "no-undef": 2,
  37 + "no-unused-vars": 2,
  38 + "brace-style": 2,
  39 + "no-mixed-spaces-and-tabs": 2,
  40 + "key-spacing": 2,
  41 + "comma-spacing": 2,
  42 + "array-bracket-spacing": 2,
  43 + "space-in-parens": 2,
  44 + "no-trailing-spaces": 2,
  45 + "comma-dangle": 2,
  46 + "comma-style": 2,
  47 + "space-infix-ops": 2,
  48 + "keyword-spacing": 2,
  49 + "space-before-blocks": 2,
  50 + "spaced-comment": 2,
  51 + "no-multiple-empty-lines": [
  52 + 2,
  53 + {
  54 + "max": 1
  55 + }
  56 + ],
  57 + "complexity": 2,
  58 + "max-depth": [
  59 + 2,
  60 + {
  61 + "max": 3
  62 + }
  63 + ],
  64 + "default-case": 0,
  65 + "dot-notation": 2,
  66 + "no-alert": 2,
  67 + "no-empty-function": 0,
  68 + "no-eval": 2,
  69 + "no-extend-native": 2,
  70 + "no-extra-bind": 2,
  71 + "no-implicit-coercion": 2,
  72 + "no-multi-spaces": 2,
  73 + "no-useless-return": 2,
  74 + "no-console": 0,
  75 + "global-require": 1,
  76 + "camelcase": 2,
  77 + "computed-property-spacing": 2,
  78 + "consistent-this": 2,
  79 + "func-call-spacing": 2,
  80 + "func-names": 2,
  81 + "func-name-matching": 2,
  82 + "func-style": [
  83 + 2,
  84 + "declaration",
  85 + {
  86 + "allowArrowFunctions": true
  87 + }
  88 + ],
  89 + "indent": [
  90 + 2,
  91 + 2,
  92 + {
  93 + "SwitchCase": 1
  94 + }
  95 + ],
  96 + "line-comment-position": 2,
  97 + "linebreak-style": [2, "unix"],
  98 + "lines-around-comment": 2,
  99 + "max-statements-per-line": 2,
  100 + "no-lonely-if": 2,
  101 + "prefer-const": 2,
  102 + "no-mixed-operators": 2,
  103 + "no-multi-assign": 2,
  104 + "no-unneeded-ternary": 2,
  105 + "object-property-newline": [
  106 + 2,
  107 + {
  108 + "allowAllPropertiesOnSameLine": true
  109 + }
  110 + ],
  111 + "operator-linebreak": 2,
  112 + "quote-props": [2, "as-needed"],
  113 + "quotes": [2, "single"],
  114 + "semi": 2,
  115 + "semi-spacing": 2,
  116 + "one-var": [2, "never"],
  117 + "eol-last": 2,
  118 + "newline-after-var": 0,
  119 + "no-var": 2,
  120 + "@typescript-eslint/no-empty-function": 0,
  121 + "no-case-declarations": 0,
  122 + "@typescript-eslint/no-var-requires": 0,
  123 + "@typescript-eslint/no-explicit-any": 0,
  124 + "@typescript-eslint/explicit-function-return-type": 0,
  125 + "@typescript-eslint/no-unused-vars": 2,
  126 + "@typescript-eslint/ban-ts-ignore": 0,
  127 + "@typescript-eslint/explicit-module-boundary-types": "off"
  128 + },
  129 + "overrides": [
  130 + {
  131 + "files": "*.ts",
  132 + "rules": {
  133 + "no-undef": "off",
  134 + "no-unused-vars": "off"
  135 + }
  136 + },
  137 + {
  138 + "files": ["*.ts", "*.tsx"],
  139 + "rules": {
  140 + "@typescript-eslint/explicit-module-boundary-types": ["error"]
  141 + }
  142 + }
  143 + ]
  144 +}
.gitattributes 0 → 100644
  View file @5390ddc
  1 +++ a/.gitattributes
  1 +*.js text eol=lf
  2 +*.ts text eol=lf
0 \ No newline at end of file 3 \ No newline at end of file
.github/CONTRIBUTING.md 0 → 100644
  View file @5390ddc
  1 +++ a/.github/CONTRIBUTING.md
  1 +# Contributing to @vuestorefront/__replace_me__
  2 +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
  3 +
  4 +- Reporting a bug
  5 +- Discussing the current state of the code
  6 +- Submitting a fix
  7 +- Proposing new features
  8 +- Becoming a maintainer
  9 +
  10 +## We Develop with Github
  11 +We use github to host code, to track issues and feature requests, as well as accept pull requests.
  12 +
  13 +## Any contributions you make will be under the MIT Software License
  14 +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
  15 +
  16 +## Report bugs using Github's [issues](https://github.com/vuestorefront/__replace_me__/issues)
  17 +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/vuestorefront/__replace_me__/issues/new); it's that easy!
  18 +
  19 +## Write bug reports with detail, background, and sample code
  20 +**Great Bug Reports** tend to have:
  21 +
  22 +- A quick summary and/or background
  23 +- Steps to reproduce
  24 + - Be specific!
  25 + - Give sample code if you can.
  26 +- What you expected would happen
  27 +- What actually happens
  28 +- The environment you're running the application
  29 +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
  30 +
  31 +People *love* thorough bug reports. I'm not even kidding.
  32 +
  33 +## License
  34 +By contributing, you agree that your contributions will be licensed under its MIT License.
.github/ISSUE_TEMPLATE/1.bug-report.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/ISSUE_TEMPLATE/1.bug-report.yml
  1 +name: "🐛 Bug report"
  2 +description: Report errors or unexpected behavior
  3 +labels:
  4 + - bug
  5 + - triage-needed
  6 +title: '[Bug]: '
  7 +body:
  8 + - type: markdown
  9 + attributes:
  10 + value: |
  11 + Thanks for taking the time to fill out this bug report, please make sure to [search for existing issues](https://github.com/vuestorefront/<% REPOSITORY %>/issues) before filing a new one!
  12 + - type: textarea
  13 + id: whattoexpect
  14 + attributes:
  15 + label: Expected Behavior
  16 + placeholder: What were you expecting?
  17 + validations:
  18 + required: false
  19 + - type: textarea
  20 + id: whathappened
  21 + attributes:
  22 + label: Actual Behavior
  23 + placeholder: What happened instead??
  24 + validations:
  25 + required: true
  26 + - type: textarea
  27 + id: solution
  28 + attributes:
  29 + label: Possible Solution
  30 + description: Also, if possible provide the information on how to implement the solution.
  31 + placeholder: Do you have any possible solution or fix for this bug?
  32 + validations:
  33 + required: false
  34 + - type: textarea
  35 + id: reproduce
  36 + attributes:
  37 + label: Steps to reproduce
  38 + description: Please provide detailed instructions on how to reproduce.
  39 + placeholder: How we can reproduce this bug?
  40 + validations:
  41 + required: false
  42 + - type: input
  43 + attributes:
  44 + label: What version of __replace_me__ integration are you using?
  45 + description: 'For example: 1.0.0'
  46 + validations:
  47 + required: true
  48 + - type: input
  49 + attributes:
  50 + label: What version of Node.js are you using?
  51 + description: 'For example: 14.0.0'
  52 + validations:
  53 + required: true
  54 + - type: input
  55 + attributes:
  56 + label: What browser (and version) are you using?
  57 + description: 'For example: Chrome, Safari'
  58 + validations:
  59 + required: true
  60 + - type: input
  61 + attributes:
  62 + label: What operating system (and version) are you using?
  63 + description: 'For example: macOS, Windows'
  64 + validations:
  65 + required: true
  66 + - type: textarea
  67 + id: logs
  68 + attributes:
  69 + label: Relevant log output
  70 + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
  71 + render: shell
  72 + - type: checkboxes
  73 + id: terms
  74 + attributes:
  75 + label: Code of Conduct
  76 + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/<% REPOSITORY %>/blob/master/CODE_OF_CONDUCT.md)
  77 + options:
  78 + - label: I agree to follow this project's Code of Conduct
  79 + required: true
.github/ISSUE_TEMPLATE/2.documentation-issue.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/ISSUE_TEMPLATE/2.documentation-issue.yml
  1 +name: "📚 Documentation Issue"
  2 +description: |
  3 + Report issues in our documentation
  4 +labels:
  5 + - documentation
  6 + - triage-needed
  7 +body:
  8 + - type: textarea
  9 + attributes:
  10 + label: Provide a description of requested docs changes
  11 + placeholder: Briefly describe which document needs to be corrected.
  12 + validations:
  13 + required: true
  14 + - type: checkboxes
  15 + id: fixthebug
  16 + attributes:
  17 + label: Able to fix / change the documentation?
  18 + description: Can you handle this change and create a Pull Request?
  19 + options:
  20 + - label: 'Yes'
  21 + required: false
  22 + - label: 'No'
  23 + required: false
  24 + - type: checkboxes
  25 + id: terms
  26 + attributes:
  27 + label: Code of Conduct
  28 + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/__replace_me__/blob/master/CODE_OF_CONDUCT.md)
  29 + options:
  30 + - label: I agree to follow this project's Code of Conduct
  31 + required: true
.github/ISSUE_TEMPLATE/3.feature-request.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/ISSUE_TEMPLATE/3.feature-request.yml
  1 +name: "🚀 Feature Request"
  2 +description: Sugest a new feature request or improvement on the project
  3 +title: '[Feature]: '
  4 +labels:
  5 + - feature
  6 + - enhancement
  7 + - triage-needed
  8 +
  9 +body:
  10 + - type: markdown
  11 + attributes:
  12 + value: |
  13 + Please, provide as many information, and knowledge so the feature can be correctly designed and developed.
  14 + - type: textarea
  15 + id: suggestion
  16 + attributes:
  17 + label: How the project can be improved?
  18 + description: What is the motivation for adding / enhancing this feature? Can you describe a concrete use case for this feature or why one of current ones should be enhanced.
  19 + placeholder: Describe the motivation or the concrete use case
  20 + validations:
  21 + required: true
  22 + - type: textarea
  23 + id: acceptcriterea
  24 + attributes:
  25 + label: What are the acceptance criteria?
  26 + description: List the acceptance criteria for this task in a form of a list.
  27 + value: '- [ ]'
  28 + - type: textarea
  29 + id: additionalinfo
  30 + attributes:
  31 + label: Additional information
  32 + description: If you think that any additional information would be useful please provide them here.
  33 + - type: checkboxes
  34 + id: terms
  35 + attributes:
  36 + label: Code of Conduct
  37 + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/__replace_me__/blob/master/CODE_OF_CONDUCT.md)
  38 + options:
  39 + - label: I agree to follow this project's Code of Conduct
  40 + required: true
.github/ISSUE_TEMPLATE/4.question.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/ISSUE_TEMPLATE/4.question.yml
  1 +name: "❓ Question / Basic Issue"
  2 +description: |
  3 + Do you have a question on the implementation or a basic issue
  4 +labels:
  5 + - triage-needed
  6 +body:
  7 + - type: markdown
  8 + attributes:
  9 + value: If you are not sure how something works or want discuss something just describe your doubts.
  10 + - type: textarea
  11 + attributes:
  12 + label: What is your question / Please describe your issue
  13 + validations:
  14 + required: true
  15 + - type: input
  16 + attributes:
  17 + label: What version of __replace_me__ integration are you using?
  18 + description: 'For example: 1.0.0'
  19 + validations:
  20 + required: true
  21 + - type: checkboxes
  22 + id: terms
  23 + attributes:
  24 + label: Code of Conduct
  25 + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/vue-storefront/blob/master/CODE_OF_CONDUCT.md)
  26 + options:
  27 + - label: I agree to follow this project's Code of Conduct
  28 + required: true
.github/ISSUE_TEMPLATE/config.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/ISSUE_TEMPLATE/config.yml
  1 +blank_issues_enabled: false
  2 +contact_links:
  3 + - name: Discord Chat
  4 + url: https://discord.vuestorefront.io/
  5 + about: Ask questions and discuss with other Vue Storefront users in real time.
.github/PULL_REQUEST_TEMPLATE.md 0 → 100644
  View file @5390ddc
  1 +++ a/.github/PULL_REQUEST_TEMPLATE.md
  1 +<!--- Provide a general summary of your changes in the Title above -->
  2 +
  3 +## Description
  4 +<!--- Describe your changes in detail -->
  5 +
  6 +## Related Issue
  7 +<!--- This project only accepts pull requests related to open issues -->
  8 +<!--- If suggesting a new feature or change, please discuss it in an issue first -->
  9 +<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
  10 +<!--- Please link to the issue here: -->
  11 +
  12 +## Motivation and Context
  13 +<!--- Why is this change required? What problem does it solve? -->
  14 +
  15 +## How Has This Been Tested?
  16 +<!--- Please describe in detail how you tested your changes. -->
  17 +<!--- Include details of your testing environment, and the tests you ran to -->
  18 +<!--- see how your change affects other areas of the code, etc. -->
  19 +
  20 +## Screenshots (if appropriate):
  21 +
  22 +## Types of changes
  23 +<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
  24 +- [ ] Bug fix (non-breaking change which fixes an issue)
  25 +- [ ] New feature (non-breaking change which adds functionality)
  26 +- [ ] Breaking change (fix or feature that would cause existing functionality to change)
  27 +
  28 +## Checklist:
  29 +<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
  30 +<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
  31 +- [ ] My code follows the code style of this project.
  32 +- [ ] My change requires a change to the documentation.
  33 +- [ ] I have updated the documentation accordingly.
  34 +- [ ] I have read the **CONTRIBUTING** document.
  35 +- [ ] I have added tests to cover my changes.
  36 +- [ ] All new and existing tests passed.
.github/workflows/assing-pr-to-author.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/workflows/assing-pr-to-author.yml
  1 +name: PR to Author
  2 +on:
  3 + pull_request:
  4 + types: [opened, ready_for_review, edited, synchronize]
  5 +
  6 +jobs:
  7 + assignAuthor:
  8 + name: Assing
  9 + runs-on: ubuntu-latest
  10 + steps:
  11 + - uses: samspills/assign-pr-to-author@v1.0
  12 + if: github.event_name == 'pull_request' && github.event.action == 'opened'
  13 + with:
  14 + repo-token: '${{ secrets.GITHUB_TOKEN }}'
.github/workflows/conventional-pr-name.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/workflows/conventional-pr-name.yml
  1 +name: Commitlint PR Title
  2 +
  3 +on:
  4 + pull_request:
  5 + types: ['opened', 'edited', 'reopened', 'synchronize']
  6 +
  7 +jobs:
  8 + lint:
  9 + name: Validate PR Title (conventional-commit)
  10 + runs-on: ubuntu-latest
  11 + steps:
  12 + - name: Checkout code
  13 + uses: actions/checkout@v2
  14 +
  15 + - name: Setup node
  16 + uses: actions/setup-node@v2
  17 + with:
  18 + node-version: '14'
  19 + cache: 'yarn'
  20 +
  21 + - name: Install dependencies
  22 + run: yarn install --frozen-lockfile
  23 +
  24 + - uses: JulienKode/pull-request-name-linter-action@v0.1.2
.github/workflows/docs-deployment.yaml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/workflows/docs-deployment.yaml
  1 +name: Deploy Documentation
  2 +on:
  3 + workflow_dispatch:
  4 +
  5 +jobs:
  6 + build:
  7 + runs-on: ubuntu-latest
  8 + steps:
  9 + - name: Checkout code
  10 + uses: actions/checkout@v1
  11 + - shell: bash
  12 + run: |
  13 + echo "1.0.`date +%s`" > version.txt
  14 + - name: Upload version artifact
  15 + uses: actions/upload-artifact@v2
  16 + with:
  17 + name: version
  18 + path: version.txt
  19 + - name: Get the version
  20 + id: get_version
  21 + run: echo ::set-output name=VERSION::$(cat version.txt)
  22 + - name: Build and publish docker image
  23 + uses: elgohr/Publish-Docker-Github-Action@master
  24 + with:
  25 + name: docs-storefrontcloud-io/v2-__replace_me__:${{ steps.get_version.outputs.VERSION }}
  26 + registry: registry.storefrontcloud.io
  27 + username: ${{ secrets.DOCS_CLOUD_USERNAME }}
  28 + password: ${{ secrets.DOCS_CLOUD_PASSWORD }}
  29 + workdir: .
  30 + dockerfile: ./.vuestorefrontcloud/docker/docs/Dockerfile
  31 + buildoptions: "--compress"
  32 +
  33 + deploy:
  34 + runs-on: ubuntu-latest
  35 + needs: build
  36 + steps:
  37 + - name: Download version artifact
  38 + uses: actions/download-artifact@v2
  39 + with:
  40 + name: version
  41 + - name: Get the version
  42 + id: get_version
  43 + run: echo ::set-output name=VERSION::$(cat version.txt)
  44 + - uses: chrnorm/deployment-action@releases/v1
  45 + name: Create GitHub deployment
  46 + id: deployment
  47 + with:
  48 + token: "${{ github.token }}"
  49 + target_url: https://docs.europe-west1.gcp.storefrontcloud.io/__replace_me__
  50 + environment: production
  51 + initial_status: in_progress
  52 + - name: Deploy on docs.europe-west1.gcp.storefrontcloud.io/__replace_me__
  53 + run: |
  54 + if curl -s -H 'X-User-Id: ${{ secrets.DOCS_CLOUD_USERNAME }}' -H 'X-Api-Key: ${{ secrets.DOCS_CLOUD_PASSWORD }}' -H 'Content-Type: application/json' -X POST -d '{"code":"docs","region":"europe-west1.gcp","additionalApps":{"apps":[{"name":"docs-v2-__replace_me__","tag":"${{ steps.get_version.outputs.VERSION }}","image":"registry.storefrontcloud.io/docs-storefrontcloud-io/v2-__replace_me__","path":"/__replace_me__","port":"80"}]}}' https://farmer.storefrontcloud.io/instances | grep -q '{"code":200,"result":"Instance updated!"}'; then
  55 + echo "Instance updated"
  56 + else
  57 + echo "Something went wrong during the update process..."
  58 + exit 1
  59 + fi
  60 + - name: Update deployment status (success)
  61 + if: success()
  62 + uses: chrnorm/deployment-status@releases/v1
  63 + with:
  64 + token: "${{ github.token }}"
  65 + target_url: https://docs.europe-west1.gcp.storefrontcloud.io/__replace_me__
  66 + state: "success"
  67 + description: Congratulations! The deploy is done.
  68 + deployment_id: ${{ steps.deployment.outputs.deployment_id }}
  69 + - name: Update deployment status (failure)
  70 + if: failure()
  71 + uses: chrnorm/deployment-status@releases/v1
  72 + with:
  73 + token: "${{ github.token }}"
  74 + target_url: https://docs.europe-west1.gcp.storefrontcloud.io/__replace_me__
  75 + description: Unfortunately, the instance hasn't been updated.
  76 + state: "failure"
  77 + deployment_id: ${{ steps.deployment.outputs.deployment_id }}
.github/workflows/publish.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/workflows/publish.yml
  1 +name: Publish Packages on NPM
  2 +on:
  3 + workflow_dispatch:
  4 + inputs:
  5 + npmTag:
  6 + description: 'NPM Tag'
  7 + required: true
  8 + default: 'latest'
  9 +jobs:
  10 + publishing:
  11 + name: Package Publishing
  12 + runs-on: ubuntu-latest
  13 + env:
  14 + NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
  15 + steps:
  16 + - name: Checkout code
  17 + uses: actions/checkout@v2
  18 +
  19 + - name: Setup node
  20 + uses: actions/setup-node@v2
  21 + with:
  22 + node-version: '14'
  23 + registry-url: "https://registry.npmjs.org/"
  24 + scope: "@vue-storefront"
  25 + - run: echo "" >> .npmrc && echo "@vue-storefront:registry=https://registry.npmjs.org/" >> .npmrc
  26 + - run: yarn
  27 + env:
  28 + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
  29 + - run: yarn build:api-client && yarn publish:api-client "${{ github.event.inputs.npmTag }}" "$NODE_AUTH_TOKEN"
  30 + env:
  31 + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
  32 + - run: yarn build:composables && yarn publish:composables "${{ github.event.inputs.npmTag }}" "$NODE_AUTH_TOKEN"
  33 + env:
  34 + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
.github/workflows/test.yml 0 → 100644
  View file @5390ddc
  1 +++ a/.github/workflows/test.yml
  1 +name: Test & Lint
  2 +
  3 +on:
  4 + push:
  5 + branches:
  6 + - master
  7 + - main
  8 + - develop
  9 + pull_request:
  10 + branches:
  11 + - master
  12 + - main
  13 + - develop
  14 +
  15 +jobs:
  16 + prepare_dependencies:
  17 + name: Install dependencies
  18 + runs-on: ubuntu-latest
  19 + steps:
  20 + - name: Checkout code
  21 + uses: actions/checkout@v2
  22 +
  23 + - name: Setup node
  24 + uses: actions/setup-node@v2
  25 + with:
  26 + node-version: '14'
  27 + cache: 'yarn'
  28 +
  29 + - name: Install dependencies
  30 + run: yarn --frozen-lockfile
  31 +
  32 + lint:
  33 + name: Run linter
  34 + needs: prepare_dependencies
  35 + runs-on: ubuntu-latest
  36 + steps:
  37 + - name: Checkout code
  38 + uses: actions/checkout@v2
  39 +
  40 + - name: Setup node
  41 + uses: actions/setup-node@v2
  42 + with:
  43 + node-version: '14'
  44 + cache: 'yarn'
  45 +
  46 + - name: Install dependencies
  47 + run: yarn --frozen-lockfile
  48 +
  49 + - name: Run linter
  50 + run: yarn lint
  51 +
  52 + test:
  53 + name: Test all packages
  54 + needs: prepare_dependencies
  55 + runs-on: ubuntu-latest
  56 + steps:
  57 + - name: Checkout code
  58 + uses: actions/checkout@v2
  59 +
  60 + - name: Setup node
  61 + uses: actions/setup-node@v2
  62 + with:
  63 + node-version: '14'
  64 + cache: 'yarn'
  65 +
  66 + - name: Install dependencies
  67 + run: yarn --frozen-lockfile
  68 +
  69 + - name: Build api-client
  70 + run: yarn build:api-client
  71 +
  72 + - name: Test api-client
  73 + run: yarn test:api-client
  74 +
  75 + - name: Build composables
  76 + run: yarn build:composables
  77 +
  78 + - name: Test composables
  79 + run: yarn test:composables
  80 +
  81 + - name: Build theme
  82 + run: yarn build:theme
  83 +
  84 + - name: Test theme
  85 + run: yarn test:theme
.gitignore 0 → 100644
  View file @5390ddc
  1 +++ a/.gitignore
  1 +# Dependency directories
  2 +node_modules
  3 +
  4 +# Logs
  5 +npm-debug.log*
  6 +yarn-debug.log*
  7 +yarn-error.log*
  8 +lerna-debug.log*
  9 +
  10 +# NPM config
  11 +.npmrc
  12 +
  13 +# Yarn Integrity file
  14 +.yarn-integrity
  15 +
  16 +# Rollup generate output
  17 +lib
  18 +
  19 +# Coverage directory used by tools like istanbul
  20 +coverage
  21 +
  22 +# Editor directories and files
  23 +.idea
  24 +.vscode
  25 +
  26 +# OS generated files
  27 +.DS_STORE
  28 +
  29 +!scripts/lib
.husky/.gitignore 0 → 100644
  View file @5390ddc
  1 +++ a/.husky/.gitignore
  1 +_
.husky/commit-msg 0 → 100644
  View file @5390ddc
  1 +++ a/.husky/commit-msg
  1 +#!/bin/sh
  2 +. "$(dirname "$0")/_/husky.sh"
  3 +
  4 +npx commitlint --edit
.husky/pre-commit 0 → 100644
  View file @5390ddc
  1 +++ a/.husky/pre-commit
  1 +#!/bin/sh
  2 +. "$(dirname "$0")/_/husky.sh"
  3 +
  4 +# add "--parallel" once this bug is fixed https://github.com/okonet/lint-staged/issues/988
  5 +npx lerna run precommit
.husky/prepare-commit-msg 0 → 100644
  View file @5390ddc
  1 +++ a/.husky/prepare-commit-msg
  1 +#!/bin/sh
  2 +. "$(dirname "$0")/_/husky.sh"
  3 +
  4 +exec < /dev/tty && git cz --hook || true
.ncurc.json 0 → 100644
  View file @5390ddc
  1 +++ a/.ncurc.json
  1 +{
  2 + "reject": [
  3 + "typescript"
  4 + ]
  5 +}
.prettierrc 0 → 100644
  View file @5390ddc
  1 +++ a/.prettierrc
  1 +{
  2 + "endOfLine": "lf",
  3 + "semi": true,
  4 + "singleQuote": true,
  5 + "arrowParens": "always",
  6 + "tabWidth": 2,
  7 + "bracketSpacing": true
  8 +}
.vuestorefrontcloud/docker/docs/Dockerfile 0 → 100644
  View file @5390ddc
  1 +++ a/.vuestorefrontcloud/docker/docs/Dockerfile
  1 +FROM node:14 AS build
  2 +
  3 +WORKDIR /var/www
  4 +
  5 +COPY . .
  6 +
  7 +RUN yarn install --network-concurrency 1
  8 +RUN cd packages/api-client && yarn build && yarn cache clean --all
  9 +RUN cd packages/composables && yarn build && yarn cache clean --all
  10 +
  11 +RUN cd docs \
  12 + && npm install \
  13 + && sed -i "s/base: '\/',/base: '\/__replace_me__\/',/g" ./.vuepress/config.js \
  14 + && cat ./.vuepress/config.js \
  15 + && npm run build
  16 +
  17 +FROM nginx
  18 +
  19 +COPY --from=build /var/www/docs/.vuepress/dist /usr/share/nginx/html/__replace_me__
.vuestorefrontcloud/docker/docs/build-docker.sh 0 → 100644
  View file @5390ddc
  1 +++ a/.vuestorefrontcloud/docker/docs/build-docker.sh
  1 +TAG=`git rev-parse HEAD`
  2 +docker build --progress plain -t registry.storefrontcloud.io/docs-storefrontcloud-io/v2-__replace_me__:${TAG:0:8} -f Dockerfile ../../../
  3 +# docker push registry.storefrontcloud.io/docs-storefrontcloud-io/v2-__replace_me__:${TAG:0:8}
CODE_OF_CONDUCT.md 0 → 100644
  View file @5390ddc
  1 +++ a/CODE_OF_CONDUCT.md
  1 +# Contributor Covenant Code of Conduct
  2 +
  3 +## Our Pledge
  4 +
  5 +We as members, contributors, and leaders pledge to make participation in our
  6 +community a harassment-free experience for everyone, regardless of age, body
  7 +size, visible or invisible disability, ethnicity, sex characteristics, gender
  8 +identity and expression, level of experience, education, socio-economic status,
  9 +nationality, personal appearance, race, caste, color, religion, or sexual identity
  10 +and orientation.
  11 +
  12 +We pledge to act and interact in ways that contribute to an open, welcoming,
  13 +diverse, inclusive, and healthy community.
  14 +
  15 +## Our Standards
  16 +
  17 +Examples of behavior that contributes to a positive environment for our
  18 +community include:
  19 +
  20 +* Demonstrating empathy and kindness toward other people
  21 +* Being respectful of differing opinions, viewpoints, and experiences
  22 +* Giving and gracefully accepting constructive feedback
  23 +* Accepting responsibility and apologizing to those affected by our mistakes,
  24 + and learning from the experience
  25 +* Focusing on what is best not just for us as individuals, but for the
  26 + overall community
  27 +
  28 +Examples of unacceptable behavior include:
  29 +
  30 +* The use of sexualized language or imagery, and sexual attention or
  31 + advances of any kind
  32 +* Trolling, insulting or derogatory comments, and personal or political attacks
  33 +* Public or private harassment
  34 +* Publishing others' private information, such as a physical or email
  35 + address, without their explicit permission
  36 +* Other conduct which could reasonably be considered inappropriate in a
  37 + professional setting
  38 +
  39 +## Enforcement Responsibilities
  40 +
  41 +Community leaders are responsible for clarifying and enforcing our standards of
  42 +acceptable behavior and will take appropriate and fair corrective action in
  43 +response to any behavior that they deem inappropriate, threatening, offensive,
  44 +or harmful.
  45 +
  46 +Community leaders have the right and responsibility to remove, edit, or reject
  47 +comments, commits, code, wiki edits, issues, and other contributions that are
  48 +not aligned to this Code of Conduct, and will communicate reasons for moderation
  49 +decisions when appropriate.
  50 +
  51 +## Scope
  52 +
  53 +This Code of Conduct applies within all community spaces, and also applies when
  54 +an individual is officially representing the community in public spaces.
  55 +Examples of representing our community include using an official e-mail address,
  56 +posting via an official social media account, or acting as an appointed
  57 +representative at an online or offline event.
  58 +
  59 +## Enforcement
  60 +
  61 +Instances of abusive, harassing, or otherwise unacceptable behavior may be
  62 +reported to the community leaders responsible for enforcement at
  63 +contributors@vuestorefront.io
  64 +All complaints will be reviewed and investigated promptly and fairly.
  65 +
  66 +All community leaders are obligated to respect the privacy and security of the
  67 +reporter of any incident.
  68 +
  69 +## Enforcement Guidelines
  70 +
  71 +Community leaders will follow these Community Impact Guidelines in determining
  72 +the consequences for any action they deem in violation of this Code of Conduct:
  73 +
  74 +### 1. Correction
  75 +
  76 +**Community Impact**: Use of inappropriate language or other behavior deemed
  77 +unprofessional or unwelcome in the community.
  78 +
  79 +**Consequence**: A private, written warning from community leaders, providing
  80 +clarity around the nature of the violation and an explanation of why the
  81 +behavior was inappropriate. A public apology may be requested.
  82 +
  83 +### 2. Warning
  84 +
  85 +**Community Impact**: A violation through a single incident or series
  86 +of actions.
  87 +
  88 +**Consequence**: A warning with consequences for continued behavior. No
  89 +interaction with the people involved, including unsolicited interaction with
  90 +those enforcing the Code of Conduct, for a specified period of time. This
  91 +includes avoiding interactions in community spaces as well as external channels
  92 +like social media. Violating these terms may lead to a temporary or
  93 +permanent ban.
  94 +
  95 +### 3. Temporary Ban
  96 +
  97 +**Community Impact**: A serious violation of community standards, including
  98 +sustained inappropriate behavior.
  99 +
  100 +**Consequence**: A temporary ban from any sort of interaction or public
  101 +communication with the community for a specified period of time. No public or
  102 +private interaction with the people involved, including unsolicited interaction
  103 +with those enforcing the Code of Conduct, is allowed during this period.
  104 +Violating these terms may lead to a permanent ban.
  105 +
  106 +### 4. Permanent Ban
  107 +
  108 +**Community Impact**: Demonstrating a pattern of violation of community
  109 +standards, including sustained inappropriate behavior, harassment of an
  110 +individual, or aggression toward or disparagement of classes of individuals.
  111 +
  112 +**Consequence**: A permanent ban from any sort of public interaction within
  113 +the community.
  114 +
  115 +## Attribution
  116 +
  117 +This Code of Conduct is adapted from the [Contributor Covenant][homepage],
  118 +version 2.0, available at
  119 +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
  120 +
  121 +Community Impact Guidelines were inspired by
  122 +[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
  123 +
  124 +For answers to common questions about this code of conduct, see the FAQ at
  125 +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
  126 +at [https://www.contributor-covenant.org/translations][translations].
  127 +
  128 +[homepage]: https://www.contributor-covenant.org
  129 +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
  130 +[Mozilla CoC]: https://github.com/mozilla/diversity
  131 +[FAQ]: https://www.contributor-covenant.org/faq
  132 +[translations]: https://www.contributor-covenant.org/translations
CONTRIBUTING.md 0 → 100644
  View file @5390ddc
  1 +++ a/CONTRIBUTING.md
  1 +# Contributing
  2 +
  3 +Yeay! You want to contribute to @vuestorefront/__replace_me__. That's amazing! To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.
  4 +
  5 +
  6 +## Found an Issue?
  7 +
  8 +Thank you for reporting any issues you find. We do our best to test and make @vuestorefront/__replace_me__ as solid as possible, but any reported issue is a real help.
  9 +
  10 +Please follow these guidelines when reporting issues:
  11 +
  12 +- Provide a title in the format of `<Error> when <Task>`
  13 +- Tag your issue with the tag `bug`
  14 +- Provide a short summary of what you are trying to do
  15 +- Provide the log of the encountered error if applicable
  16 +- Provide the exact version of @vuestorefront/__replace_me__.
  17 +- Be awesome and consider contributing a [pull request](#want-to-contribute)
  18 +
  19 +## Want to contribute?
  20 +
  21 +Please consider these guidelines when filing a pull request:
  22 +
  23 +> @vuestorefront/__replace_me__ pull requests
  24 +
  25 +- Follow the [Coding Rules](#coding-rules)
  26 +- Follow the [Commit Rules](#commit-rules)
  27 +- Make sure you rebased the current master branch when filing the pull request
  28 +- Squash your commits when filing the pull request
  29 +- Provide a short title with a maximum of 100 characters
  30 +- Provide a more detailed description containing
  31 + _ What you want to achieve
  32 + _ What you changed
  33 + _ What you added
  34 + _ What you removed
  35 +
  36 +## Coding Rules
  37 +
  38 +To keep the code base of @vuestorefront/__replace_me__ neat and tidy the following rules apply to every change
  39 +
  40 +> Coding standards
  41 +
  42 +- `eslint` is king
  43 +- Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
  44 +- Be awesome
  45 +
  46 +## Commit Rules
  47 +
  48 +To help everyone with understanding the commit history of commitlint the following commit rules are enforced.
  49 +To make your life easier @vuestorefront/__replace_me__ is commitizen-friendly and provides the npm run-script `commit`.
  50 +
  51 +> Commit standards
  52 +
  53 +- [conventional-changelog](https://github.com/conventional-changelog)
  54 +- husky commit message hook available
  55 +- present tense
  56 +- maximum of 100 characters
  57 +- message format of `$type($scope): $message`
LICENSE 0 → 100644
  View file @5390ddc
  1 +++ a/LICENSE
  1 +MIT License
  2 +
  3 +Copyright (c) 2021 Vue Storefront
  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 0 → 100644
  View file @5390ddc
  1 +++ a/README.md
  1 +# Boilerplate for Vue Storefront 2 eCommerce integration
  2 +
  3 +This is a template, to use it you must rename the project changing the `{YOUR INTEGRATION NAME}` to the name of the integration you are developing. The name must be in lowercase and without any special characters.
  4 +
  5 +```sh
  6 +grep -rl '__replace_me__' ./ | xargs sed -i '' 's/__replace_me__/{YOUR INTEGRATION NAME}/g'
  7 +```
  8 +
  9 +------
  10 +
  11 +<div align="center">
  12 + <img src="https://user-images.githubusercontent.com/1626923/137092657-fb398d20-b592-4661-a1f9-4135db0b61d5.png" alt="Vue Storefront" height="80px" />
  13 +</div>
  14 +
  15 +## Vue Storefront 2 integration with __replace_me__
  16 +
  17 +### Stay connected
  18 +
  19 +[![GitHub Repo stars](https://img.shields.io/github/stars/vuestorefront/vue-storefront?style=social)](https://github.com/vuestorefront/vue-storefront)
  20 +[![Twitter Follow](https://img.shields.io/twitter/follow/vuestorefront?style=social)](https://twitter.com/vuestorefront)
  21 +[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCkm1F3Cglty3CE1QwKQUhhg?style=social)](https://www.youtube.com/c/VueStorefront)
  22 +[![Discord](https://img.shields.io/discord/770285988244750366?label=join%20discord&logo=Discord&logoColor=white)](https://discord.vuestorefront.io)
  23 +
  24 +To learn how to build your integration, see our [Integration guide](https://docs.vuestorefront.io/v2/integrate/integration-guide.html).
  25 +
  26 +------
  27 +
  28 +<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
  29 +<!-- ALL-CONTRIBUTORS-BADGE:END -->
  30 +
  31 +## How to start if you want to try out the integration
  32 +
  33 +```
  34 +yarn global add @vue-storefront/cli
  35 +```
  36 +```
  37 +vsf init <project_name> && cd <project_name> && yarn && yarn dev
  38 +```
  39 +
  40 +## How to start if you want to contribute?
  41 +
  42 +Want to contribute? Ping us on `__replace_me__` channel on [our Discord](https://discord.vuestorefront.io)!
  43 +
  44 +### Requirements:
  45 +- NodeJS v14 or later
  46 +
  47 +### Steps
  48 +1. Fork the repo
  49 +2. Clone your fork of the repo
  50 + ```
  51 + example:
  52 + git clone https://github.com/vuestorefront/__replace_me__.git
  53 + cd __replace_me__
  54 + ```
  55 +3. Run `yarn` to install dependencies
  56 +4. Build dependencies `yarn build:api-client && yarn build:composables`
  57 +5. Run `yarn dev:theme` to run theme. You can find other commands in `package.json`
  58 +
  59 +- If you need HMR on Api Client/Composables run `yarn dev:api-client` or `yarn dev:composables` on a separate terminal window.
  60 +
  61 +## Resources
  62 +
  63 +- [Vue Storefront Documentation](https://docs.vuestorefront.io/v2/)
  64 +- [__replace_me__ integration Documentation](https://docs.vuestorefront.io/__replace_me__)
  65 +- [Community Chat](https://discord.vuestorefront.io)
  66 +
  67 +## Support
  68 +
  69 +If you have any questions about this integration we will be happy to answer them on `__replace_me__` channel on [our Discord](discord.vuestorefront.io).
  70 +
  71 +## Contributors ✨
  72 +
  73 +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
  74 +
  75 +<!-- ALL-CONTRIBUTORS-LIST:END -->
  76 +
  77 +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
api-extractor.base.json 0 → 100644
  View file @5390ddc
  1 +++ a/api-extractor.base.json
  1 +{
  2 + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
  3 + "projectFolder": ".",
  4 + "compiler": {
  5 + "tsconfigFilePath": "<projectFolder>/tsconfig.base.json"
  6 + },
  7 + "docModel": {
  8 + "enabled": true
  9 + },
  10 + "dtsRollup": {
  11 + "enabled": true
  12 + },
  13 + "tsdocMetadata": {
  14 + "enabled": false
  15 + },
  16 + "apiReport": {
  17 + "enabled": false
  18 + },
  19 + "messages": {
  20 + "compilerMessageReporting": {
  21 + "default": {
  22 + "logLevel": "warning"
  23 + }
  24 + },
  25 + "extractorMessageReporting": {
  26 + "default": {
  27 + "logLevel": "none",
  28 + "addToApiReportFile": false
  29 + },
  30 + "ae-extra-release-tag": {
  31 + "logLevel": "none",
  32 + "addToApiReportFile": false
  33 + },
  34 + "ae-forgotten-export": {
  35 + "logLevel": "none"
  36 + }
  37 + },
  38 + "tsdocMessageReporting": {
  39 + "default": {
  40 + "logLevel": "none",
  41 + "addToApiReportFile": false
  42 + }
  43 + }
  44 + }
  45 +}
commitlint.config.js 0 → 100644
  View file @5390ddc
  1 +++ a/commitlint.config.js
  1 +module.exports = { extends: ['@commitlint/config-conventional'] };
docs/.vuepress/config.js 0 → 100644
  View file @5390ddc
  1 +++ a/docs/.vuepress/config.js
  1 +module.exports = {
  2 + title: 'Vue Storefront 2 for __replace_me__',
  3 + base: '/',
  4 + description: 'Documentation for the __replace_me__ connector for Vue Storefront 2',
  5 + head: [
  6 + ['link', { rel: 'icon', href: '/favicon.png' }]
  7 + ],
  8 + configureWebpack: (config) => {
  9 + config.module.rules = config.module.rules.map(rule => ({
  10 + ...rule,
  11 + use: rule.use && rule.use.map(useRule => ({
  12 + ...useRule,
  13 + options: useRule.loader === 'url-loader' ?
  14 + /**
  15 + Hack for loading images properly.
  16 + ref: https://github.com/vuejs/vue-loader/issues/1612#issuecomment-559366730
  17 + */
  18 + { ...useRule.options, esModule: false } :
  19 + useRule.options
  20 + }))
  21 + }))
  22 + },
  23 + plugins: [
  24 + '@vuepress/plugin-back-to-top',
  25 + [
  26 + '@vuepress/plugin-medium-zoom',
  27 + {
  28 + // This selector excludes images from the "Integrations" page
  29 + selector: 'main :not(.tile-image) > img'
  30 + }
  31 + ],
  32 + '@vuepress/active-header-links',
  33 + '@vuepress/search'
  34 +],
  35 + themeConfig: {
  36 + repo: 'https://github.com/vuestorefront/__replace_me__',
  37 + editLinks: true,
  38 + docsDir: 'docs',
  39 + docsBranch: 'develop',
  40 + editLinkText: 'Edit this page',
  41 + logo: 'https://user-images.githubusercontent.com/1626923/137092657-fb398d20-b592-4661-a1f9-4135db0b61d5.png',
  42 + nav: [
  43 + { text: 'Vue Storefront', link: 'https://vuestorefront.io/' },
  44 + { text: 'Core Documentation', link: 'https://docs.vuestorefront.io/v2/' },
  45 + // { text: 'Demo', link: '' },
  46 + { text: 'GitHub', link: 'https://github.com/vuestorefront/__replace_me__'},
  47 + { text: 'Roadmap', link: 'https://github.com/vuestorefront/__replace_me__'}
  48 + ],
  49 + sidebar: [
  50 + {
  51 + title: 'Essentials',
  52 + collapsable: false,
  53 + children: [
  54 + ['/', 'Introduction'],
  55 + ['/guide/getting-started', 'Getting started'],
  56 + ['/guide/configuration', 'Configuration'],
  57 + ['/guide/about', 'About'],
  58 + ]
  59 + },
  60 + {
  61 + title: 'Composables',
  62 + path: '/composables/'
  63 + },
  64 + {
  65 + title: 'API Client',
  66 + path: '/api-client/'
  67 + },
  68 + ]
  69 + }
  70 +}
docs/.vuepress/enhanceApp.js 0 → 100644
  View file @5390ddc
  1 +++ a/docs/.vuepress/enhanceApp.js
  1 +/**
  2 + * Client app enhancement file.
  3 + *
  4 + * https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
  5 + */
  6 +
  7 +export default ({
  8 + Vue, // the version of Vue being used in the VuePress app
  9 + options, // the options for the root Vue instance
  10 + router, // the router instance for the app
  11 + siteData // site metadata
  12 +}) => {
  13 + // ...apply enhancements for the site.
  14 +}
docs/.vuepress/public/favicon.png 0 → 100644
View file @5390ddc

1.31 KB
docs/.vuepress/styles/index.styl 0 → 100644
  View file @5390ddc
  1 +++ a/docs/.vuepress/styles/index.styl
  1 +/**
  2 + * Custom Styles here.
  3 + *
  4 + * ref：https://v1.vuepress.vuejs.org/config/#index-styl
  5 + */
  6 +
  7 +.home .hero img
  8 + max-width 450px!important
docs/.vuepress/styles/palette.styl 0 → 100644
  View file @5390ddc
  1 +++ a/docs/.vuepress/styles/palette.styl
  1 +/**
  2 + * Custom palette here.
  3 + *
  4 + * ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
  5 + */
  6 +
  7 +$accentColor = #3eaf7c
  8 +$textColor = #2c3e50
  9 +$borderColor = #eaecef
  10 +$codeBgColor = #282c34
docs/guide/about.md 0 → 100644
  View file @5390ddc
  1 +++ a/docs/guide/about.md
  1 +# About
  2 +
  3 +## Resources
  4 +
  5 +- [Vue Storefront Documentation](https://docs.vuestorefront.io/v2/)
  6 +- [Community Chat](https://discord.vuestorefront.io)
  7 +
  8 +## Support
  9 +
  10 +If you have any questions about this integration we will be happy to answer them on `__replace_me__` channel on [our Discord](discord.vuestorefront.io).
docs/guide/configuration.md 0 → 100644
  View file @5390ddc
  1 +++ a/docs/guide/configuration.md
  1 +# Configuration
docs/guide/getting-started.md 0 → 100644
  View file @5390ddc
  1 +++ a/docs/guide/getting-started.md
  1 +# Getting Started
  2 +
  3 +## How to start if you want to try out the integration
  4 +
  5 +```
  6 +yarn global add @vue-storefront/cli
  7 +```
  8 +```
  9 +vsf init <project_name> && cd <project_name> && yarn && yarn dev
  10 +```
  11 +
  12 +## How to start if you want to contribute?
  13 +
  14 +Want to contribute? Ping us on `__replace_me__` channel on [our Discord](https://discord.vuestorefront.io)!
  15 +
docs/index.md 0 → 100644
  View file @5390ddc
  1 +++ a/docs/index.md
  1 +<img src="https://blog.vuestorefront.io/wp-content/uploads/2020/01/1QU9F6hQlFyHsJIbsdmt6FA.png" height="100px" />
  2 +
  3 +# Vue Storefront 2 integration with __replace_me__
  4 +
  5 +This project is a __replace_me__ integration for Vue Storefront 2.
  6 +
  7 +This integration is currently a **Beta** and not ready for production usage. You can help us to make the integration production-ready faster by reporting bugs and contributing to the code at the [repository issues page](https://github.com/vuestorefront/__replace_me__/issues).
docs/package.json 0 → 100644
  View file @5390ddc
  1 +++ a/docs/package.json
  1 +{
  2 + "name": "vsf-integration-docs",
  3 + "version": "0.0.1",
  4 + "description": "Documentation for __replace_me__ integration for Vue Storefront",
  5 + "main": "index.js",
  6 + "license": "MIT",
  7 + "repository": "https://github.com/vuestorefront/__replace_me__/docs",
  8 + "scripts": {
  9 + "dev": "vuepress dev",
  10 + "build": "vuepress build",
  11 + "api-extract": "yarn api-ref && yarn comp-ref && yarn ref-md",
  12 + "api-ref": "cd ../packages/api-client && api-extractor run --local",
  13 + "comp-ref": "cd ../packages/composables && api-extractor run --local",
  14 + "ref-md": "api-documenter markdown --i api-reference --o api-reference"
  15 + },
  16 + "devDependencies": {
  17 + "@microsoft/api-documenter": "^7.13.65",
  18 + "@microsoft/api-extractor": "^7.18.17",
  19 + "@vuepress/plugin-active-header-links": "^1.8.2",
  20 + "@vuepress/plugin-back-to-top": "^1.8.2",
  21 + "@vuepress/plugin-medium-zoom": "^1.8.2",
  22 + "@vuepress/plugin-search": "^1.8.2",
  23 + "handlebars": "^4.7.7",
  24 + "typescript": "^4.5.4",
  25 + "vuepress": "^1.8.2"
  26 + },
  27 + "dependencies": {
  28 + "sass-loader": "^8.0.2",
  29 + "vue-multiselect": "^2.1.6"
  30 + }
  31 +}