Quick Start

Installation

To get a project set up with Totem:

1. Ensure all Prerequisites are met

   Prerequisites

   • Bootstrap AWS and GitHub accounts so they can talk to each other
   • Bootstrap GitHub Organization account with Private NPM token

2. Create a Totem config file in the root of the project

   .totemrc.yaml

    version: 1
    name: test-static-site
    targets:
      not-prod:
        type: aws
        env: aws://1234567890/us-west-2
        profile: melt_not-prod_admin
    services:
      site:
        type: static-site
        description: An Example Static Site
    build:
      type: github-actions
      autoSynth: true
      branches:
        develop:
          target: target://not-prod
          services:
            site:
              domains:
                - zoneName: meltdev.com
                - recordName: test-site.develop
      commands:
        - yarn install
        - yarn build
      artifactDir: dist

3. Create a CDK state file in the root of the project

   cdk.json

    {
      "app": "npx @meltmedia/totem synth",
      "output": "cdk.out"
    }

4. Synthesize the necessary CDK and GitHub files

    npx aws-cdk synth

Important

Be sure to run npx aws-cdk synth after making any changes to your .totemrc.yaml file.

Deploy

Your app is now ready to be deployed. When you commit your changes and push to GitHub, GitHub Actions will build and deploy your app