Skip to content

Documentation update #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 27, 2023
Merged

Documentation update #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7e0078
Added pulumi prerequisites
Oct 26, 2023
870c8ad
Added missing details
Oct 27, 2023
aaa89b9
Updated link
Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,15 @@ Studion Platform common infra components.

## Table of Contents

1. [Installation](#installation)
2. [Usage](#usage)
3. [API](#api)
1. [Prerequisites](#prerequisites)
2. [Installation](#installation)
3. [Usage](#usage)
4. [API](#api)

## Prerequisites

- Working [Pulumi](https://www.pulumi.com/docs/clouds/aws/get-started/begin/#pulumi-aws-before-you-begin) project
- AWS account with neccessary permissions for each studion component

## Installation

Expand Down Expand Up @@ -42,6 +48,12 @@ const project = new studion.Project('demo-project', {
export const projectName = project.name;
```

- Deploy pulumi stack

```bash
$ pulumi up
```

## API

1. [Project](#project)
Expand Down Expand Up @@ -83,7 +95,7 @@ type ProjectArgs = {
| Argument | Description |
| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------: |
| services \* | Service list. |
| hostedZoneId | Route53 hosted zone ID responsible for managing records for the domain. |
| hostedZoneId | Route53 hosted zone ID responsible for managing records for the domain. Required for 'STATIC_SITE' and 'WEB_SERVER' |
| enableSSMConnect | Setup ec2 instance and SSM in order to connect to the database in the private subnet. Please refer to the [SSM Connect](#ssm-connect) section for more info. |

```ts
Expand Down