Skip to content
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.

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

Update aws instructions #55

Merged
merged 1 commit into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
Here's your GitHub README with emojis added:

````markdown
# hexyback-workshop

## Visit our hosted documentation
## Visit our hosted documentation 📚

https://benbowers.github.io/hexyback-workshop/
[Hexyback Workshop Documentation](https://benbowers.github.io/hexyback-workshop/)

## About
## About ℹ️

This educational journey is designed for enthusiastic learners like you, aiming to demystify the complexities of cloud technology and application architecture.

Expand All @@ -14,7 +17,7 @@ Our curriculum is structured around the concept of hexagonal architecture, also

To streamline our development and deployment processes, we'll employ SST (Serverless Stack), a modern framework designed to simplify the building and managing of serverless applications on AWS. SST features live Lambda development, which means you can test your Lambda functions locally without redeploying them to the cloud. This immediate feedback loop accelerates the development cycle and enhances your understanding of cloud infrastructure.

## Install
## Install 🛠️

This project will require NodeJS20, pnpm & the AWS cli v2

Expand All @@ -23,6 +26,7 @@ This project will require NodeJS20, pnpm & the AWS cli v2
```sh
pnpm i
```
````

### Start the docs

Expand All @@ -49,3 +53,8 @@ pnpm run test
```sh
pnpm run test:integration
```

```

I've added emojis to the headings and some relevant sections to make it more visually appealing and engaging.
```
10 changes: 6 additions & 4 deletions docs/docs/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,25 @@ Before diving into the heart of this workshop, ensure you have the following too

## Setting Up AWS Access

### Step 1: Access Your AWS Account
### IAM User (Reccomened for workshop)

#### Step 1: Access Your AWS Account

Navigate to the [AWS Management Console](https://aws.amazon.com/console/) and log in with your credentials.

### Step 2: Establish an IAM User
#### Step 2: Establish an IAM User

1. Within the AWS Management Console, select **IAM** under Security, Identity, & Compliance from the **Services** dropdown.
2. Click **Add users** in the IAM dashboard's Users section.
3. Set your username (e.g., `hexy-workshop-user`) and choose **Programmatic access** to generate an access key ID and secret access key.
4. Proceed to **Permissions**.

### Step 3: Grant AdministratorAccess
#### Step 3: Grant AdministratorAccess

1. Select **Attach existing policies directly** and find `AdministratorAccess`.
2. After selecting the policy, you can optionally add tags before reviewing and confirming the user creation.

### Step 4: Secure Your Credentials
#### Step 4: Secure Your Credentials

Upon user creation, download and securely store the `.csv` file containing your new credentials—remember, this is your only chance to copy these details.

Expand Down