Basic configurations
github-learning-lab opened this issue · comments
Basic configurations
For your Mac setup video, click here
Introduction
Before getting your hands dirty and learning more about VTEX IO's Store Framework, you'll need to set up a few basic configurations, such as:
- Installing Git;
- Installing Toolbelt;
- Logging into a VTEX account;
- Creating a development workspace;
- Linking your local files to the platform.
Have a look at the step-by-step below for each of these configurations:
Installing Git
Install Git on your computer by clicking on the link below and selecting your operating system (Windows, MAC or Linux):
Installing Toolbelt
Toolbelt is a VTEX command line tool. It allows you to perform any activity on the platform, such as creating a new development workspace, logging into a VTEX account, developing new apps, or managing already existing ones, etc.
Since it's Toolbelt that establishes the communication between the developer and the platform, you'll need it in order to perform all the activities put forward during the Store Framework course.
- Install Node.js. If you are using a MAC, also install Yarn;
- Run
npm i -g vtex
in your terminal if you're using Windows oryarn global add vtex
if you're using MAC;
Your can run vtex-v
(Windows) or vtex
(MAC) to confirm whether the Toolbelt installation was as expected.
Once successfully installed, your next step is to log into a VTEX account.
Logging in
-
Run
vtex login VTEXaccount
in your terminal, replacingVTEXaccount
with the name of the account in which you want to work. For example,vtex login appliancetheme
. -
After logging in, run
vtex whoami
to confirm the account and workspace in which you find currently are.
Workspaces are nothing other than what the namesake suggests. On VTEX IO, accounts have three main workspace types, namely master, production and development.
The next step is to create a development workspace, which will allow you to play with the configurations throughout the course without altering the store's final public version.
Creating a development workspace
- Run
vtex use workspace-name
, replacingworkspace-name
with the desired name. For example,vtex use devworkspace
.
Accessing your workspace
After creating the workspace, you'll be able to access it at this link: https://{workspace}--{account}.myvtex.com
, replacing {workspace}
and {conta}
with the name of the previously created workspace and account. For example, https://devworkspace--appliancetheme.myvtex.com
After setting up the basic configurations, you're ready to start the course!