@xapp/studio-deploy v0.0.30

Studio Deploy

Purpose

This script is designed for single-tenant users to integrate Studio Single Tenant in a Continuniuos Integration Platform.

It is writtein in Typescript and compiles to Javascript. It can be run either with ts-node or node.

Requirements

Node version 14+ needs to be installed on the computer. Then use either npm or yarn for packaging and script running.

Setup AWS

1. Create an AWS account in which to deploy Studio to.
2. Create an IAM user with administrator priviledges that allows this script to assume. The policy attached to this user is also the policy that CloudFormation will use to deploy the client and API
3. Create a programmatic access and secret access key for the IAM user and save these credentials as a profile in the ~/.aws/credentials file.
4. Create two S3 buckets. One bucket will be used to deploy the client to and the other will be used to deploy the API code to. These buckets must be in the same region that the Studio is to be deployed to.

Setup Script

1. Download or clone this repo.

2. Install app packages:

   ```
       yarn install
   ```
   
   or
   
   ```
       npm install
   ```

   3a. Add the following environment variables to your system.

• STUDIO_CF_DISTRO_DOMAIN - This is the domain that is part of the cloudfront distribution that will deliver the website.
• STUDIO_CLIENT_S3_BUCKET - This is the name of the bucket that was created to store the client.
• STUDIO_API_S3_BUCKET - This is the name of the bucket that was created to store the api client.
• STUDIO_COGNITO_DOMAIN - This is the domain name unique to your organization that Cognito will use for signing in.
• STUDIO_SIGNED_URL - This is the signed URL that allows access to the Studio code. This is provided by a XAPP.AI administrator. 3b. Alternatiely, these environment variables can be added to a .env file at the root of the project. An example file is located in this package.

4. The AWS credentials set for the environemnt will be the ones used to deploy Studio to the account.
5. The Studio will be deployed to the region that the AWS environment is set to.

Execute

All scripts can be executed using ts-node. To execute a script, run node_modules/.bin/ts-node ./src/index.ts <command>

Run node_modules/.bin/ts-node ./src/index.ts -h for a full list of commands that are available as well as their descriptions

If npm or yarn is preferred, the following scripts are available:

1. commands - This is equivalent to node_modules/.bin/ts-node ./src/index.ts -h and will list the available commands.
2. execute - This is a shorthand for node_modules/.bin/ts-node ./srcs/index.ts and will allow commands to be executed.