In this quickstart tutorial, you'll create an Inventory Management System app using one of our templates.
Follow the steps below to get started.
Prerequisite
You'll need a Tailor account to start using the Tailor Platform.
Contact us here to get started.
Install Tailor CLI
tailorctl is a command-line utility that enables you to interact with the Tailor Platform, from creating your workspace to deploying applications.
To install tailorctl, run the following command.
Terraform is an infrastructure-as-code tool designed to help you create, modify, and manage infrastructure securely and effectively.
You can see the Tailor Platform Provider documentation here.
Visit the Install Terraform page.
Download the latest version of Terraform for the Windows operating system that matches your CPU architecture.
For Windows users: Once you have downloaded these files, place the .exe files in a directory that is included in your system's PATH environment variable.
This will allow you to run the executables from any command prompt or PowerShell session.
Install Tailor CLI
CUE is a powerful configuration language that allows you to evaluate and validate your application's configuration.
Visit the Cue release page.
Download the latest version of Cue for the Windows operating system that matches your CPU architecture.
For Windows users: Once you have downloaded these files, place the .exe files in a directory that is included in your system's PATH environment variable.
This will allow you to run the executables from any command prompt or PowerShell session.
1. Log in to the Tailor Platform with SSO.
Run the following command to log in to the Tailor Platform using your account information:
Once you run this command, your browser will open and you'll be prompted to log in to the Tailor Platform with your SSO account.
Please sign in with your email address and password. Your initial password has been sent to you upon account creation.
If you haven't received it, please check your spam folder or contact us for assistance.
Navigate to the workspace.tf file and update the region attribute to match the region suitable for your location. Currently, we support two regions: us-west and asia-northeast.
resource "tailor_workspace" "ims" {
name = "ims"
region = "us-west" # Replace "us-west" with your preferred region
}
output "workspace" {
value = tailor_workspace.ims.id
}
Initialize app configuration
Run the following command to prepare your Terraform working directory by configuring the backend and installing providers.
Currently, we support two regions us-west and asia-northeast.
Generate app configuration
To generate configuration files, let's first synchronize the local cue.mod files with tailorctl.
Then, generate a UUID and inject it into environment/env.cue. This UUID will be used to seed data into the application.
Caveat: The cue version defined in the module.cue, file located in the
cue.mod directory, must match the cue version specified by the Tailor
platform. This is necessary to synchronize the local cue.mod files with
tailorctl.
4. Deploy the app
Apply the configuration to create a workspace and deploy the app.
Open the GraphQL Playground for the application using the following command.
The GraphQL Playground allows you to run GraphQL queries to Tailor Platform services.
<span><span style="color: var(--shiki-token-comment)"># The `-n` flag specifies the application name. In this quickstart, the default name is `ims`.</span></span>
<span><span style="color: var(--shiki-token-function)">tailorctl</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workspace</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">app</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">open</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">-n</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">ims</span></span>
<span></span>
<span><span style="color: var(--shiki-token-comment)"># The `-n` flag specifies the application name. In this quickstart, the default name is `ims`.</span></span>
<span><span style="color: var(--shiki-token-function)">tailorctl.exe</span><span style="color: var(--shiki-color-text)"> workspace app open </span><span style="color: var(--shiki-token-keyword)">-</span><span style="color: var(--shiki-color-text)">n ims</span></span>
<span></span>
6. Get the access token to use the GraphQL API in the playground
To get an access token to use the GraphQL API in the playground, run the following command.
In this case, we use the admin-machine-user machine user which is predefined in this template to get the access token.
Once you get an access token, you can use it in the playground to run queries.
Please set the token in the Headers section of the playground as follows:
For apps created using CUE: Please refer to the README for detailed information about this template and instructions on seeding initial data for your application.
Further information
Congratulations on creating your first app in the Tailor Platform!
Here are some next steps to help you continue learning:
Discover Core Concepts to get an overview of Tailor Platform.