-
Notifications
You must be signed in to change notification settings - Fork 208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md #199
Open
guerreirobeatriz
wants to merge
2
commits into
master
Choose a base branch
from
store-theme-documentation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update README.md #199
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
|---|---|---|
| @@ -1,44 +1,30 @@ | ||
| # Store theme | ||
| Our boilerplate theme to create stores in the VTEX IO platform. | ||
| # Store Theme | ||
|
|
||
| ## Preview | ||
|  | ||
|
|
||
| ## Tutorial | ||
| To understand how things work check our tutorial [Build a store using VTEX IO](https://vtex.io/docs/getting-started/build-stores-with-vtex-io/1) | ||
| Store Theme is a boilerplate theme based on the VTEX IO Store Framework with **pre-configured blocks and templates for store's front**. | ||
|
|
||
| ## Dependencies | ||
| All store components that you see on this document are open source too. Production ready, you can found those apps in this GitHub organization. | ||
|
|
||
| Store framework is the baseline to create any store using _VTEX IO Web Framework_. | ||
| - [Store](https://github.com/vtex-apps/store/blob/master/README.md) | ||
|  | ||
|
|
||
| Store GraphQL is a middleware to access all VTEX APIs. | ||
| - [Store GraphQL](https://github.com/vtex-apps/store-graphql/blob/master/docs/README.md) | ||
| The theme's default configurations will allow you to work in a **swift** and **easy** way, avoiding the need to build your store's front from scratch. If you want to build without these pre-configurations, you should access the [Minimum Boilerplate Theme](https://github.com/vtex-apps/minimum-boilerplate-theme/pull/1)repository and follow the indicated steps. | ||
|
|
||
| ### Store Component Apps | ||
| - [Header](https://github.com/vtex-apps/store-header/blob/master/docs/README.md) | ||
| - [Footer](https://github.com/vtex-apps/store-footer/blob/master/docs/README.md) | ||
| - [Slider Layout](https://github.com/vtex-apps/slider-layout/blob/master/docs/README.md) | ||
| - [Shelf](https://github.com/vtex-apps/shelf/blob/master/docs/README.md) | ||
| - [Telemarketing](https://github.com/vtex-apps/telemarketing/blob/master/docs/README.md) | ||
| - [Menu](https://github.com/vtex-apps/menu/blob/master/docs/README.md) | ||
| - [Login](https://github.com/vtex-apps/login/blob/master/docs/README.md) | ||
| - [Minicart](https://github.com/vtex-apps/minicart/blob/master/docs/README.md) | ||
| - [Category Menu](https://github.com/vtex-apps/category-menu/blob/master/docs/README.md) | ||
| - [Product Summary](https://github.com/vtex-apps/product-summary/blob/master/docs/README.md) | ||
| - [Breadcrumb](https://github.com/vtex-apps/breadcrumb/blob/master/docs/README.md) | ||
| - [Search Result](https://github.com/vtex-apps/search-result/blob/master/docs/README.md) | ||
| - [Product Details](https://github.com/vtex-apps/product-details/blob/master/docs/README.md) | ||
| - [Store Components](https://github.com/vtex-apps/store-components/blob/master/docs/README.md) | ||
| - [Order Placed](https://github.com/vtex-apps/order-placed/blob/master/docs/README.md) | ||
| - [Product Kit](https://github.com/vtex-apps/product-kit/blob/master/docs/README.md) :construction: under construction | ||
| Once the Store Theme is a boilerplate theme, it includes all default blocks any store's front could ask for, such as: | ||
|
|
||
| ### Store Pixel Apps | ||
| - [Header](https://vtex.io/docs/components/all/vtex.store-header/) | ||
| - [Shelf](https://vtex.io/docs/components/all/vtex.shelf/) | ||
| - [Menu](https://vtex.io/docs/components/all/vtex.menu/) | ||
| - [Logo](https://vtex.io/docs/components/all/vtex.store-components/logo) | ||
| - [Login](https://vtex.io/docs/components/all/vtex.login/) | ||
| - [Infocard](https://vtex.io/docs/components/all/vtex.store-components/info-card) | ||
| - [Product Name](https://vtex.io/docs/components/product/vtex.store-components/product-name) | ||
| - [Product Price](https://vtex.io/docs/components/product/vtex.store-components/product-price) | ||
| - [Minicart](https://vtex.io/docs/components/all/vtex.minicart/) | ||
| - [Breadcrumb](https://vtex.io/docs/components/all/vtex.breadcrumb/) | ||
| - [Infocard](https://vtex.io/docs/components/all/vtex.store-components/info-card) | ||
| - [SKU Selector](https://vtex.io/docs/components/all/vtex.store-components/sku-selector) | ||
| - [Image](https://vtex.io/docs/components/all/vtex.store-components/image) | ||
| - [Footer](https://vtex.io/docs/components/all/vtex.store-footer/) | ||
|
|
||
| - [Facebook Pixel](https://github.com/vtex-apps/facebook-pixel/blob/master/docs/README.md) | ||
| - [Google Tag Manager](https://github.com/vtex-apps/google-tag-manager/blob/master/docs/README.md) | ||
| Notice: **all Store Framework store blocks are open source**, including those imported by Store Theme. Production ready, you can contribute to developing these apps by simply accessing their documentation in this Github organization (`vtex-apps`). | ||
|
|
||
| ## Contributing | ||
| ## Configuration | ||
|
|
||
| Check it out [how to contribute](https://github.com/vtex-apps/awesome-io#contributing) with this project. | ||
| In order to learn how to build your store's front using the Store Theme repository, check out our documentation on how to [Build a store using VTEX IO](https://vtex.io/docs/getting-started/build-stores-with-vtex-io/1) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think it makes sense to add a link to the "minimum boiler plate" in this doc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You added the link to the store theme docs in the minimum boiler plate, so I thought it would be nice to refer it back here as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with you! Thanks :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done