-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit f64d4c2
Showing
31 changed files
with
10,837 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"projectName": "react-app-template", | ||
"projectOwner": "vtex-apps", | ||
"repoType": "github", | ||
"repoHost": "https://github.com", | ||
"files": [ | ||
"docs/README.md" | ||
], | ||
"imageSize": 100, | ||
"commit": true, | ||
"commitConvention": "none", | ||
"contributors": [], | ||
"contributorsPerLine": 7 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# editorconfig.org | ||
root = true | ||
|
||
[*] | ||
end_of_line = lf | ||
insert_final_newline = true | ||
indent_style = space | ||
indent_size = 2 | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
node_modules/ | ||
coverage/ | ||
*.snap.ts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"extends": "vtex", | ||
"root": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
### SublimeText ### | ||
*.sublime-workspace | ||
|
||
### OSX ### | ||
.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
Icon | ||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear on external disk | ||
.Spotlight-V100 | ||
.Trashes | ||
|
||
### Windows ### | ||
# Windows image file caches | ||
Thumbs.db | ||
ehthumbs.db | ||
|
||
# Folder config file | ||
Desktop.ini | ||
|
||
# Recycle Bin used on file shares | ||
$RECYCLE.BIN/ | ||
|
||
# App specific | ||
node_modules/ | ||
docs/_book/ | ||
.tmp | ||
.idea | ||
npm-debug.log | ||
.build/ | ||
lib | ||
dist | ||
build | ||
lerna-debug.log | ||
yarn-error.log | ||
*.orig |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
"@vtex/prettier-config" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"recommendations": [ | ||
"dbaeumer.vscode-eslint", | ||
"EditorConfig.EditorConfig", | ||
"esbenp.prettier-vscode" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{ | ||
"editor.formatOnSave": true, | ||
"editor.codeActionsOnSave": { | ||
"source.fixAll.eslint": true | ||
}, | ||
"eslint.validate": [ | ||
"javascript", | ||
"javascriptreact", | ||
"typescript", | ||
"typescriptreact" | ||
], | ||
"eslint.alwaysShowStatus": true, | ||
"eslint.packageManager": "yarn", | ||
"eslint.workingDirectories": [ | ||
{ | ||
"directory": "react", | ||
"changeProcessCWD": true | ||
}, | ||
{ | ||
"directory": "node", | ||
"changeProcessCWD": true | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
version: 0.2 | ||
phases: | ||
install: | ||
commands: | ||
- echo Installing Packages... | ||
- cd react | ||
- npm install | ||
- echo Packages installed! | ||
pre_build: | ||
commands: | ||
- echo Running tests... | ||
- npm run test | ||
- echo Lint and tests finished! | ||
cache: | ||
paths: | ||
- 'node_modules/**/*' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# general | ||
**/node_modules/ | ||
/.git/ | ||
/package.json | ||
/README.md | ||
/crowdin.yml | ||
|
||
# tools | ||
**/.eslintrc | ||
**/.prettierrc | ||
**/.gitignore | ||
|
||
# tests | ||
**/__tests__ | ||
**/__mocks__ | ||
**/*.test.* | ||
react/testUtils/** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## [Unreleased] | ||
|
||
### Added | ||
- Initial release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"section": "orders", | ||
"titleId": "admin-example.navigation.label", | ||
"path": "/admin/telemetry" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"admin.app.example": { | ||
"component": "telemetry", | ||
"path": "/admin/app/telemetry" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
files: | ||
- source: /messages/en.json | ||
translation: /messages/%two_letters_code%.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
// dangerfile.js | ||
const { verify } = require('@vtex/danger') | ||
|
||
const config = { | ||
// Set to true to enforce keepachangelog rules. | ||
keepachangelog: { | ||
changeVersion: false, | ||
}, | ||
rules: { | ||
description: ['fail', { minLength: 20 }], | ||
assignee: 'fail', | ||
reviewers: 'fail', | ||
pr_size: ['warn', { additionLimit: 800, deletionLimit: -1 }], | ||
lock_file: 'warn', | ||
no_ignored_test: ['fail', { pattern: /test|spec/i }], | ||
no_debugger: ['fail', { pattern: /\.[tj]sx?$/i }], | ||
enforce_graphql_provider: 'off', | ||
}, | ||
} | ||
|
||
verify(config) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
📢 Use this project, [contribute](https://github.com/{OrganizationName}/{AppName}) to it or open issues to help evolve it using [Store Discussion](https://github.com/vtex-apps/store-discussion). | ||
|
||
# APP NAME | ||
|
||
<!-- DOCS-IGNORE:start --> | ||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
[](#contributors-) | ||
<!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
<!-- DOCS-IGNORE:end --> | ||
|
||
Under the app's name, you should explain the topic, giving a **brief description** of its **functionality** in a store when installed. | ||
|
||
Next, **add media** (either an image of a GIF) with the rendered components, so that users can better understand how the app works in practice. | ||
|
||
 | ||
|
||
## Configuration | ||
|
||
In this section, you first must **add the primary instructions** that will allow users to use the app's blocks in their store, such as: | ||
|
||
1. Adding the app as a theme dependency in the `manifest.json` file; | ||
2. Declaring the app's main block in a given theme template or inside another block from the theme. | ||
|
||
Remember to add a table with all blocks exported by the app and their descriptions. You can verify an example of it on the [Search Result documentation](https://vtex.io/docs/components/all/vtex.search-result@3.56.1/). | ||
|
||
Next, add the **props table** containing your block's props. | ||
|
||
If the app exports more than one block, create several tables - one for each block. For example: | ||
|
||
### `block-1` props | ||
|
||
| Prop name | Type | Description | Default value | | ||
| ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | ||
| `XXXXX` | `XXXXXX` | XXXXXXXX | `XXXXXX` | | ||
|
||
|
||
### `block-2` props | ||
|
||
| Prop name | Type | Description | Default value | | ||
| ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | ||
| `XXXXX` | `XXXXXX` | XXXXXXXX | `XXXXXX` | | ||
|
||
Prop types are: | ||
|
||
- `string` | ||
- `enum` | ||
- `number` | ||
- `boolean` | ||
- `object` | ||
- `array` | ||
|
||
When documenting a prop whose type is `object` or `array` another prop table will be needed. You can create it following the example below: | ||
|
||
- `propName` object: | ||
|
||
| Prop name | Type | Description | Default value | | ||
| ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | ||
| `XXXXX` | `XXXXXX` | XXXXXXXX | `XXXXXX` | | ||
|
||
|
||
Remember to also use this Configuration section to **showcase any necessary disclaimer** related to the app and its blocks, such as the different behavior it may display during its configuration. | ||
|
||
## Modus Operandi *(not mandatory)* | ||
|
||
There are scenarios in which an app can behave differently in a store, according to how it was added to the catalog, for example. It's crucial to go through these **behavioral changes** in this section, allowing users to fully understand the **practical application** of the app in their store. | ||
|
||
If you feel compelled to give further details about the app, such as it's **relationship with the VTEX admin**, don't hesitate to use this section. | ||
|
||
## Customization | ||
|
||
The first thing that should be present in this section is the sentence below, showing users the recipe pertaining to CSS customization in apps: | ||
|
||
`In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).` | ||
|
||
Thereafter, you should add a single column table with the available CSS handles for the app, like the one below. Note that the Handles must be ordered alphabetically. | ||
|
||
| CSS Handles | | ||
| ----------- | | ||
| `XXXXX` | | ||
| `XXXXX` | | ||
| `XXXXX` | | ||
| `XXXXX` | | ||
| `XXXXX` | | ||
|
||
|
||
If there are none, add the following sentence instead: | ||
|
||
`No CSS Handles are available yet for the app customization.` | ||
|
||
<!-- DOCS-IGNORE:start --> | ||
|
||
## Contributors ✨ | ||
|
||
Thanks goes to these wonderful people: | ||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
<!-- prettier-ignore-start --> | ||
<!-- markdownlint-disable --> | ||
<!-- markdownlint-enable --> | ||
<!-- prettier-ignore-end --> | ||
<!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! | ||
|
||
<!-- DOCS-IGNORE:end --> | ||
|
||
---- | ||
|
||
Check out some documentation models that are already live: | ||
- [Breadcrumb](https://github.com/vtex-apps/breadcrumb) | ||
- [Image](https://vtex.io/docs/components/general/vtex.store-components/image) | ||
- [Condition Layout](https://vtex.io/docs/components/all/vtex.condition-layout@1.1.6/) | ||
- [Add To Cart Button](https://vtex.io/docs/components/content-blocks/vtex.add-to-cart-button@0.9.0/) | ||
- [Store Form](https://vtex.io/docs/components/all/vtex.store-form@0.3.4/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"vendor": "appliancetheme", | ||
"name": "admin-sandbox", | ||
"version": "0.0.0", | ||
"title": "Telemetry", | ||
"description": "Telemetry config and viewer", | ||
"builders": { | ||
"react": "3.x", | ||
"messages": "1.x", | ||
"docs": "0.x", | ||
"admin": "0.x" | ||
}, | ||
"dependencies": { | ||
"vtex.styleguide": "9.x" | ||
}, | ||
"registries": [ | ||
"smartcheckout" | ||
], | ||
"policies": [], | ||
"$schema": "https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"admin-example.navigation.label": "Telemetry", | ||
"admin/test": "test", | ||
"store/test": "test" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"admin-example.navigation.label": "Telemetry", | ||
"admin/test": "teste", | ||
"store/test": "teste" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"admin-example.navigation.label": "Telemetry", | ||
"admin/test": "teste", | ||
"store/test": "teste" | ||
} |
Oops, something went wrong.