Skip to content

Commit c97c5e6

Browse files
authored
docs: clarify DevContainer onboarding flow (#75)
* docs: clarify DevContainer onboarding flow * docs: clarify DevContainer recommendation
1 parent 79c8651 commit c97c5e6

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,24 @@ See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for more details.
8080

8181
## Quick Start
8282

83-
### 1. Clone and bootstrap
83+
### 1. Clone the repository
8484

8585
```bash
8686
git clone https://github.com/your-org/aws-glue-etl-boilerplate.git
8787
cd aws-glue-etl-boilerplate
88+
```
89+
90+
### 2. Open the project in a Dev Container (Recommended)
91+
92+
It is recommended to open the project in the Dev Container before running any `make` commands.
93+
94+
Open the project in VS Code and select **Reopen in Container** for the recommended development environment.
95+
96+
If you are not using a Dev Container, you can still follow the documented local setup instructions below where applicable.
97+
98+
### 3. Bootstrap the project
99+
100+
```bash
88101
make bootstrap
89102
```
90103

@@ -100,7 +113,7 @@ make nan-health
100113
make nan-skills
101114
```
102115

103-
### 2. Set up environment variables
116+
### 4. Set up environment variables
104117

105118
```bash
106119
cp .env.example .env
@@ -122,7 +135,7 @@ Key variables (see [docs/ENVIRONMENT_VARIABLES.md](docs/ENVIRONMENT_VARIABLES.md
122135
| `API_BASE_URL` | `https://jsonplaceholder.typicode.com` | Base URL for public API source |
123136
| `API_ENDPOINT` | `/posts` | Endpoint path |
124137

125-
### 3. Start the local infrastructure
138+
### 5. Start the local infrastructure
126139

127140
```bash
128141
# Starts LocalStack (S3, Glue, SecretsManager) + SFTP server

0 commit comments

Comments
 (0)