Deployments

Initial deployment

Code Genie apps include a simple command to enable one-command setup:

npm run init:dev

This command does the following:

1. Installs NPM dependencies (npm i)
2. Creates a new entry in the AWS Credentials File ~/.aws/credentials called your-app-name_dev using credentials copied from the default profile.
3. Bootstraps CDK in the AWS account (cdk bootstrap)
4. Deploys to AWS (npm run deploy:dev)
5. Copies CloudFormation/CDK outputs to local .env files for running the UI and API locally (npm run copy-outputs-to-dotenv:dev)
6. Opens the live version of the web app in your browser.

AWS Profiles

If you’d rather copy credentials from a different profile, instead run COPY_AWS_PROFILE=profile-name-to-copy npm run init:dev.

Alternatively, if you’d rather manually define the profiles, run COPY_AWS_PROFILE=0 npm run init:dev. The profile name must be a kebab-cased version of the application name, followed by the environment name shorthand (_dev, _staging, _prod). See the profile values in packages/cdk/cdk.json for the exact values.

Note

Since the UI has a dependency on Cognito and the API, the init command actually runs deploy a second time.

Deploying updates

After the initial deployment, you can deploy changes to AWS with:

npm run deploy:dev

Deploying to staging and production

Similar commands exist for staging and prod:

dev

Initial install and deploy for dev

npm run init:dev
npm run deploy:dev

staging

Initial install and deploy for staging

npm run init:staging
npm run deploy:staging

prod

Initial install and deploy for prod

npm run init:prod
npm run deploy:prod

Use separate AWS Accounts for each stage

It’s recommended to use separate AWS Accounts for each stage for improved security and stability. However, if you prefer to use a single AWS Account for simplicity you can specify the same aws_access_key_id and aws_secret_access_key for all 3 profiles.

CI/CD

See the CI/CD Pipeline page for more details.