Skip to content

velosov/io-boilerplate

Repository files navigation

Basic VTEX IO App Template

Preview

FAQ and prerequisites

Some introductory videos explaining the basics

You're aiming to publish your baby @ VTEX App Store. This means you must have a certain knowledge about it's Guidelines.

Don't worry with the publication flow yet. I'll give you proper guidance when it's time.

However if you still are that really curious about pricing models and billing, I got you covered.

IO basics

First, I need to recall that everything in IO is an app. The entry point for your application is the manifest.json file.

There, you find the details (name, vendor, version) and basic configs (dependencies and policies, which we'll take a look in a sec.) Sort of IO's package.json - which by the way will also be there and require the install command, as usual. You may develop a purely front-, back-end or fullstack app; it's only a matter of importing the right builders. For example, "store": "0.x"; "node": "6.x"; and both + "react": "3.x", respectively.

Bureaucracy

As your app will be communicating through APIs, we use policies to describe its capabilities - access to domains and subdomains, logging, events, etc. Be as restrictive as possible when granting these access to your application.

I've already arranged to you the following ones:

Logistics - full access, inventory full access, shipping full access, transportation full access OMS - Change order workflow status, Notify payment, View order, Notify refund, Cancel order, Change order, View store sales stats Checkout - Shopping cart full access, Orders full access, Order cancellation

You can check in the manifest.json file.

Tutorials

There's an intro to VTEX IO Services based on Service-Example in the node folder.

Also, be sure to check the Clients we provide you out-of-the-box. This may simplify a lot your work, or at least give you some insights on how to proceed.

To understand how frontend things work check our tutorial Build a store using VTEX IO Store Framework

Admin

Please notice that following our Styleguide is mandatory.

Store

Store framework is the baseline to create any store using VTEX IO Web Framework.

Store GraphQL is a middleware to access all VTEX APIs.

The store you find here is this mock theme. I'm only letting it here so that: when you run vtex link you have a test store available + visualize the input of a custom component into the final store code, but keep in mind that your final application won't carry this out (only the proper files to export the converted components it eventually provides, namely interfaces.json and/or plugins.json).

Your app will live in the accounts of the stores in the same way the code of their site does. If between the resources you developed there's a front-end component, the stores will need to declare your app as a dependency in their manifest.json to be allowed the consumption of the block you exports - and then make the proper configurations about where to insert it. You should provide this documentation.

To have a clear sense on this, delete the files related to the ecommerce (sitemap, store/blocks, store/block.jsonc and store/routes.json). Then clone the above linked Store-There, insert your app as dependency in manifest and place it in the proper block/page.

References

VTEX Community - forum where you can see, ask and reply to questions and discussions with other IO devs List of REST APIs

About

VTEX IO App basic Template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published