Skip to content

TerraConstructs/learn

Repository files navigation

Learn TerraConstructs

Interactive Docs built with TutorialKit!

This README provides an overview of how the TerraConstructs tutorial is structured.

Project Structure

.
├── astro.config.mjs    # Astro 🚀 (https://astro.build)
├── src
│   ├── ...
│   ├── content
│   │   └── tutorial    # tutorial content lives here
│   └── templates       # templates (see below for more information)
├── public
│   ├── favicon.svg
│   └── logo.svg        # Default logo used in top left for your tutorial
├── ...
├── theme.ts            # Customize the theme of the tutorial
└── uno.config.ts       # UnoCSS config (https://unocss.dev/)

Getting Started

Make sure you have all dependencies installed and started the dev server:

pnpm install
pnpm run dev

Tool versions

Correct tool versions can be controlled using mise.

Authoring Content

[!INFO] Refer to the Content Creation section of TutorialKit Guides

Deploying

Important

Use the correct versions of required tools using mise.

# view requested config
mise ls

# install tool versions required
mise install

Synth TerraConstructs configuration

pnpm synth

Use OpenTofu to apply changes

cd cdktf.out/stacks/learn/
tofu apply

About

Interactive Tutorial for TerraConstructs

Topics

Resources

Stars

Watchers

Forks

Contributors