Merge pull request #151 from tebanieo/recipe-backend

NERDS Stack - Recipe backend - Initial Phase

Author: tebanieo

.gitignore

@@ -27,3 +27,4 @@ workshops/relational-migration/setenv.sh
 workshops/relational-migration/setenvd.sh
 workshops/relational-migration/source-tables/app_db.*
 
+**/.aws-sam/

examples/NERDS/recipe-example/README.md

@@ -0,0 +1,10 @@
+# Recipe Example
+
+This is the first full example in the NERDS stack, this examples fully uses SAM instead of ExpressJS for the backend. We will be working with a recipe sharing website! Where users can create recipes, collections, comment, share and subscribe to users, and at the end they could add elemnts to their shopping lists to buy the goods required to cook the recipe.
+
+**TODO**: This project is still work in progress and it needs additional documentation, we will be releasing the features by phases (which will be tracked in the release table below), the first one is an initial portion of the backend with only users and recipes interactions, and we will build all the way up to the full application, this approach is to make it easier to consume rather than a big bang!
+
+To execute this project please:
+
+1. Open the [backend](./backend/README.md) folder with instructions to execute the backend locally.
+2. Open the [frontend](./frontend/README.md) folder with instructions to execute the front end and run your web applicaation locally.

examples/NERDS/recipe-example/backend/.gitignore

@@ -0,0 +1,139 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+#Secret Files
+.secrets.baseline
+
+#local docker DDB file
+.ddb_cid
+
+src/package-lock.json
+**/.aws-sam/

examples/NERDS/recipe-example/backend/README.md

@@ -0,0 +1,95 @@
+# Recipes Backend Example
+
+## Description
+
+This project is a backend service for a recipe management system, built using AWS SAM (Serverless Application Model) and DynamoDB as part of the NERDS stack.
+
+## Prerequisites
+
+- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
+- [DynamoDB Local Docker Image](https://hub.docker.com/r/amazon/dynamodb-local)
+- [Node v22.3.0](https://nodejs.org/en/blog/release/v22.3.0)
+- [AWS JavaScript SDK v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/)
+- [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html)
+
+## Setup
+
+1. Install dependencies:
+
+```bash
+npm install
+```
+
+2. Start the local DynamoDB:
+
+```bash
+npm run start-db
+```
+
+3. Create the recipes table:
+
+```bash
+npm run create-recipes-table
+```
+
+4. Build the SAM application:
+
+```bash
+npm run build-backend
+```
+
+5. Start the local API:
+
+```bash
+npm run start-backend
+```
+
+# Setup
+
+![demo.gif](./documentation/demo.gif)
+
+# Creating an user
+
+![demo-api.gif](./documentation/demo-api.gif)
+
+## Available Scripts
+
+- `npm run start-db`: Start local DynamoDB container
+- `npm run stop-db`: Stop and remove local DynamoDB container
+- `npm run create-recipes-table`: Create the recipes table in local DynamoDB
+- `npm run show-tables`: List tables in local DynamoDB
+- `npm run scan-recipes`: Scan all items in the recipes table
+- `npm run build-backend`: Build the SAM application, if you change the code in the `src/*` folder you need to rebuild your project.
+- `npm run start-backend`: Start the local API
+- `npm run create-user`: Create a sample user using curl
+
+## Configuration
+
+The project uses the following configuration (defined in package.json):
+
+- DynamoDB host: `0.0.0.0`
+- DynamoDB port: `8000`
+- API port: `3000`
+- Recipe table name: `recipe_table`
+
+## API Endpoints
+
+- `POST /users`: Create a new user
+- `GET /users/{userId}`: Get user details
+- `PUT /users/{userId}`: Update user details
+- `DELETE /users/{userId}`: Delete a user
+- `POST /recipes`: Create a new recipe
+- `GET /recipes/{recipeId}`: Get recipe details
+- `PUT /recipes/{recipeId}`: Update recipe details
+- `DELETE /recipes/{recipeId}`: Delete a recipe
+- `GET /recipes`: List all recipes
+
+## Development
+
+To start development:
+
+1. Ensure local DynamoDB is running (`npm run start-db`)
+2. Make changes to the Lambda functions in the `src` directory
+3. Rebuild the application (`npm run build-backend`)
+4. Start the local API (`npm run start-backend`)
+5. Test your changes using the provided npm scripts or tools like Postman

examples/NERDS/recipe-example/backend/buildspec.yml

@@ -0,0 +1,22 @@
+version: 0.2
+phases:
+  install:
+    commands:
+      # Install all dependencies (including dependencies for running tests)
+      - npm install
+  pre_build:
+    commands:
+      # Discover and run unit tests in the '__tests__' directory
+      - npm run test
+      # Remove all unit tests to reduce the size of the package that will be ultimately uploaded to Lambda
+      - rm -rf ./__tests__
+      # Remove all dependencies not needed for the Lambda deployment package (the packages from devDependencies in package.json)
+      - npm prune --production
+  build:
+    commands:
+      # Use AWS SAM to package the application by using AWS CloudFormation
+      - aws cloudformation package --template template.yaml --s3-bucket $S3_BUCKET --output-template template-export.yml
+artifacts:
+  type: zip
+  files:
+    - template-export.yml

examples/NERDS/recipe-example/backend/docker-compose.yml

@@ -0,0 +1,11 @@
+version: "3.8"
+services:
+  dynamodb-local:
+    command: "-jar DynamoDBLocal.jar -sharedDb -dbPath ./data"
+    image: "amazon/dynamodb-local:latest"
+    container_name: dynamodb-local-recipe-backend
+    ports:
+      - "8000:8000"
+    volumes:
+      - "./docker/dynamodb:/home/dynamodblocal/data"
+    working_dir: /home/dynamodblocal

examples/NERDS/recipe-example/backend/docker/dynamodb/shared-local-instance.db

@@ -0,0 +1,5 @@
+{
+  "Parameters": {
+    "DYNAMODB_ENDPOINT": "http://dynamodb-local:8000"
+  }
+}