(blog) localstack (#118)

* Create .nvmrc

* add blog for localstack

* handle api errors

* Update localstack-your-gateway-to-cloud-testing.md

* rephrase grammar

* add return type for getCaseStudy by slug

.nvmrc

@@ -0,0 +1 @@
+v20.14.0

_blogs/localstack-your-gateway-to-cloud-testing.md

@@ -0,0 +1,180 @@
+---
+title: "LocalStack: Your Gateway to Seamless Cloud Testing Locally"
+excerpt: "Discover how LocalStack enables you to emulate AWS services locally, saving time and costs while improving productivity."
+coverImage: "/assets/blogs/localstack-your-gateway-to-cloud-testing/cover.webp"
+date: "2024-12-22T18:13:00.000Z"
+author:
+  name: Umair Jibran
+  picture: "/assets/authors/jibran.webp"
+ogImage:
+  url: "/assets/blogs/localstack-your-gateway-to-cloud-testing/cover.webp"
+tags:
+  - AWS
+  - LocalStack
+  - Cloud Development
+  - DevOps
+  - Testing
+---
+
+## What is LocalStack?
+
+[LocalStack](https://www.localstack.cloud/) is an open-source tool that creates a local environment for simulating AWS services on your machine. It is particularly popular among developers and teams for testing cloud applications without connecting to the actual AWS cloud. By mimicking various AWS APIs such as S3, Lambda, DynamoDB, and SQS, LocalStack provides a controlled, cost-effective, and fast development environment.
+
+## Why is LocalStack Important?
+
+### Cost Efficiency
+
+Developing with live AWS resources can incur significant costs, especially during frequent testing. LocalStack allows you to work offline, eliminating these expenses.
+
+### Faster Development Cycles
+
+Running AWS services locally reduces the latency of API calls, speeding up iterations and debugging.
+
+### Offline Accessibility
+
+With LocalStack, you can test and develop in environments where internet access is restricted or unavailable.
+
+### Seamless Integration
+
+LocalStack integrates with popular tools like Terraform, AWS CLI, and the AWS SDK, making it easy to incorporate into existing workflows.
+
+## What are the Benefits?
+
+- **Supports Multiple AWS APIs:** Simulate services such as S3, EC2, Lambda, DynamoDB, and many more.
+- **Docker-Based Environment:** Ensures consistency across development and testing setups.
+- **Customizable:** Extend LocalStack's capabilities to meet your specific needs.
+- **CI/CD Ready:** Perfect for testing infrastructure as code and integrating into continuous integration pipelines.
+
+## What are the Challenges?
+
+- **Incomplete Feature Set:** Not all AWS services and features are supported, especially edge cases.
+- **Performance Limitations:** While great for local testing, LocalStack isn’t designed for production or large-scale simulations.
+- **Learning Curve:** Initial setup and understanding of LocalStack can take time for new users.
+
+---
+
+## Step A: Setting Up LocalStack Environment
+
+### Prerequisites:
+
+- Docker installed on your machine
+- Basic familiarity with AWS services and the command line
+
+### Steps:
+
+#### For macOS (using Homebrew):
+
+1. **Install LocalStack via Brew**:
+
+   ```bash
+   brew install localstack
+   ```
+
+2. **Run LocalStack Using Brew**:
+
+   ```bash
+   localstack start
+   ```
+
+3. **Configure AWS CLI**:
+   ```bash
+   aws configure
+   ```
+   Use dummy credentials since LocalStack doesn’t validate them.
+
+#### For Linux (using Homebrew alternative or directly):
+
+1. **Install LocalStack via Pip**:
+
+   ```bash
+   pip install localstack
+   ```
+
+2. **Run LocalStack Using Docker**:
+
+   ```bash
+   docker run --rm -it -p 4566:4566 -p 4571:4571 localstack/localstack
+   ```
+
+3. **Configure AWS CLI**:
+   ```bash
+   aws configure
+   ```
+   Use dummy credentials since LocalStack doesn’t validate them.
+
+#### For Windows (using Chocolatey or Pip):
+
+1. **Install LocalStack via Chocolatey**:
+
+   ```powershell
+   choco install localstack
+   ```
+
+2. **Run LocalStack Using Docker**:
+
+   ```powershell
+   docker run --rm -it -p 4566:4566 -p 4571:4571 localstack/localstack
+   ```
+
+3. **Configure AWS CLI**:
+   ```powershell
+   aws configure
+   ```
+   Use dummy credentials since LocalStack doesn’t validate them.
+
+### Why This Way?
+
+Running LocalStack in a Docker container ensures a clean and isolated environment, minimizing conflicts with existing setups.
+
+### Configuration:
+
+Edit `localstack.config` to enable or disable specific AWS services:
+
+```json
+{
+  "services": ["s3", "dynamodb", "lambda"]
+}
+```
+
+Restart LocalStack after making changes.
+
+---
+
+## Step B: Testing and Troubleshooting
+
+### Testing the Setup:
+
+1. **Create an S3 Bucket:**
+   ```bash
+   aws --endpoint-url=https://localhost.localstack.cloud:4566 s3 mb s3://test-bucket
+   ```
+2. **List Buckets:**
+   ```bash
+   aws --endpoint-url=https://localhost.localstack.cloud:4566 s3 ls
+   ```
+   You should see your `test-bucket` listed.
+
+### Common Issues and Solutions:
+
+- **Issue:** "Connection refused" errors.
+  - **Solution:** Ensure Docker is running and LocalStack is started correctly.
+- **Issue:** AWS CLI unable to connect to LocalStack.
+  - **Solution:** Use the correct `--endpoint-url` in commands.
+- **Issue:** Service not recognized.
+  - **Solution:** Verify the service is enabled in `localstack.config`.
+
+---
+
+## Conclusion
+
+LocalStack is a powerful tool for developers looking to streamline cloud application testing and development. By simulating AWS services locally, it minimizes costs, enhances productivity, and provides a faster feedback loop. While it has its limitations, the benefits far outweigh the challenges, making LocalStack a must-have for modern cloud developers.
+
+---
+
+## References
+
+- [LocalStack Official Documentation](https://docs.localstack.cloud/)
+- [AWS CLI Documentation](https://aws.amazon.com/cli/)
+- [Docker Installation Guide](https://docs.docker.com/get-docker/)
+- [LocalStack GitHub Repository](https://github.com/localstack/localstack)
+- [LocalStack Academy](https://docs.localstack.cloud/academy/)

src/lib/api.ts

@@ -22,30 +22,41 @@ export function getBlogSlugs() {
   }
 }
 
-export function getBlogBySlug(slug: string) {
-  const realSlug = slug.replace(/\.md$/, "");
-  const fullPath = join(blogsDirectory, `${realSlug}.md`);
-  const fileContents = fs.readFileSync(fullPath, "utf8");
-  const { data, content } = matter(fileContents);
+export function getBlogBySlug(slug: string): Story | null {
+  try {
+    const realSlug = slug.replace(/\.md$/, "");
+    const fullPath = join(blogsDirectory, `${realSlug}.md`);
+    const fileContents = fs.readFileSync(fullPath, "utf8");
+    const { data, content } = matter(fileContents);
 
-  return { ...data, slug: realSlug, content } as Story;
+    return { ...data, slug: realSlug, content } as Story;
+  } catch (error) {
+    return null;
+  }
 }
 
 export function getAllBlog(): Story[] {
   const slugs = getBlogSlugs();
   const blogs = slugs
     .map((slug) => getBlogBySlug(slug))
-    .sort((blog1, blog2) => (blog1.date > blog2.date ? -1 : 1));
-  return blogs.map((blog) => ({ ...blog, type: "blog" }));
+    .filter((blog) => blog !== null) as Story[];
+  const sortedBlogs = blogs.sort((blog1, blog2) =>
+    blog1.date > blog2.date ? -1 : 1,
+  );
+  return sortedBlogs.map((blog) => ({ ...blog, type: "blog" }));
 }
 
-export function getCaseStudyBySlug(slug: string) {
-  const realSlug = slug.replace(/\.md$/, "");
-  const fullPath = join(caseStudiesDirectory, `${realSlug}.md`);
-  const fileContents = fs.readFileSync(fullPath, "utf8");
-  const { data, content } = matter(fileContents);
+export function getCaseStudyBySlug(slug: string): Story | null {
+  try {
+    const realSlug = slug.replace(/\.md$/, "");
+    const fullPath = join(caseStudiesDirectory, `${realSlug}.md`);
+    const fileContents = fs.readFileSync(fullPath, "utf8");
+    const { data, content } = matter(fileContents);
 
-  return { ...data, slug: realSlug, content } as Story;
+    return { ...data, slug: realSlug, content } as Story;
+  } catch (error) {
+    return null;
+  }
 }
 
 export function getAllCaseStudies(): Story[] {
@@ -55,10 +66,11 @@ export function getAllCaseStudies(): Story[] {
   }
   const caseStudies = slugs
     .map((slug) => getCaseStudyBySlug(slug))
-    .sort((caseStudy1, caseStudy2) =>
-      caseStudy1.date > caseStudy2.date ? -1 : 1,
-    );
-  return caseStudies.map((caseStudy) => ({
+    .filter((caseStudy) => caseStudy !== null) as Story[];
+  const sortedCaseStudies = caseStudies.sort((caseStudy1, caseStudy2) =>
+    caseStudy1.date > caseStudy2.date ? -1 : 1,
+  );
+  return sortedCaseStudies.map((caseStudy) => ({
     ...caseStudy,
     type: "case-study",
   }));