https://github.com/udaykumar-dhokia/aws-localstack
A hands-on learning environment for understanding AWS Cloud services without needing a real AWS account. This repository simulates AWS using LocalStack, making it ideal for beginners, students, and developers who want to master AWS fundamentals locally.
https://github.com/udaykumar-dhokia/aws-localstack
aws cloud localstack
Last synced: 3 months ago
JSON representation
A hands-on learning environment for understanding AWS Cloud services without needing a real AWS account. This repository simulates AWS using LocalStack, making it ideal for beginners, students, and developers who want to master AWS fundamentals locally.
- Host: GitHub
- URL: https://github.com/udaykumar-dhokia/aws-localstack
- Owner: udaykumar-dhokia
- Created: 2025-11-19T16:40:52.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-11-20T04:44:50.000Z (8 months ago)
- Last Synced: 2025-11-20T06:16:10.678Z (8 months ago)
- Topics: aws, cloud, localstack
- Language: TypeScript
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Self-host AWS with LocalStack
A hands-on learning environment for understanding AWS Cloud services **without needing a real AWS account**. This repository simulates AWS using **LocalStack**, making it ideal for beginners, students, and developers who want to master AWS fundamentals locally.
---
---
## What This Repository Teaches You
This project is designed as a practical learning resource for AWS. By using LocalStack, you can learn how AWS works internally _without incurring costs_.
You will learn:
- How IAM users/roles/policies work
- How S3 buckets handle storage, uploads, versioning, and permissions
- How AWS SDK clients interact with services
- How to structure cloud-based applications
- How to test AWS services locally before deploying to real AWS
This repo is like your **mini AWS sandbox**, totally offline.
---
## Project Structure
```
├── iam/ # IAM learning examples
│ └── index.ts # Create users, roles, policies
├── s3/ # S3 learning examples
│ └── index.ts # Bucket operations, uploads, list, delete
├── awsClient.ts # AWS SDK client configured for LocalStack
├── docker-compose.yml # LocalStack setup
├── .env # Environment variables
├── volume/ # LocalStack persistent data
├── package.json # Node.js config
└── README.md
```
---
## Why This Repo Exists
Most AWS tutorials jump directly into using real AWS accounts—and beginners get confused or scared to experiment due to cost.
This repository solves that by providing:
- A **safe, free AWS practice environment**
- Real AWS-like responses via LocalStack
- Modular examples so you can learn one service at a time
- Clean, beginner-friendly TypeScript code
Perfect for:
- Students
- DevOps learners
- Backend developers
- Cloud beginners
- Anyone preparing for AWS certifications
---
## Tech Used
- **TypeScript + Node.js**
- **AWS SDK v3**
- **LocalStack with Docker**
- **Docker Compose**
---
## Setup Instructions
### Install dependencies
```sh
npm install
```
### Configure environment
Create `.env` file:
```
AWS_ACCESS_KEY_ID=test
AWS_SECRET_ACCESS_KEY=test
AWS_REGION=us-east-1
LOCALSTACK_ENDPOINT=http://localhost:4566
```
### Start LocalStack
```sh
docker-compose up --build
```
---
## Running Examples
### TypeScript build
```sh
npm run build
```
### Run learning modules
iam example:
```sh
npx ts-node iam/index.ts
```
---
## Learning Modules Provided
### **IAM Module** (`/iam/index.ts`)
Learn how IAM works locally:
- Create users
- List users
### **S3 Module** (`/s3/index.ts`)
Practice S3 operations:
- Create bucket
- Upload files
- List objects
- Delete objects
- Learn bucket naming rules
- Understand access permissions
### AWS Client Wrapper (`awsClient.ts`)
Shows how to configure AWS SDK v3 to:
- Connect to LocalStack
- Override endpoints
- Use shared credentials
---
## LocalStack + Docker
Start LocalStack:
```sh
docker-compose up -d
```
Stop LocalStack:
```sh
docker-compose down
```
To reset everything:
```sh
rm -rf volume/
```
---
## Recommended Learning Path
1. **Start LocalStack**
2. Learn S3 basics (create bucket → upload → list → delete)
3. Learn IAM basics (users → roles → policies)
4. Connect AWS CLI to LocalStack
5. Expand examples (SNS, SQS, Lambda) when ready
This repo grows with you—simply add more service folders.
---
## Using AWS CLI With LocalStack
Example:
```sh
aws --endpoint-url=http://localhost:4566 s3 ls
```
Try creating buckets, listing IAM users, etc.
---
## Contributing
Got an idea for a module? Add it!
This repo aims to become a **complete AWS learning playground**.
## References
Official documentation and learning resources used in this project:
- **LocalStack – Installation Guide**
https://docs.localstack.cloud/aws/getting-started/installation/
- **LocalStack – Quickstart Guide**
https://docs.localstack.cloud/aws/getting-started/quickstart/
- **AWS SDK for JavaScript (v3) – Getting Started**
https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-started.html