|
| 1 | +# NERDS Stack - Basic Project - NodeJS Express React DynamoDB and SAM |
| 2 | + |
| 3 | +The NERDS stack will allow you to bootstrap your work with DynamoDB, you can move from Development to Production very quickly. |
| 4 | + |
| 5 | +This project contains source code and supporting files for a sample application running on Express and NodeJS with Amazon DynamoDB local. It includes the following files and folders: |
| 6 | + |
| 7 | +- `src` - Code for the express application and the APIs. |
| 8 | +- `package.json` - Includes all the scripts to work on this project and the pre-requisites. |
| 9 | + |
| 10 | +This application will create a couple of API methods to add and list the ToDos. |
| 11 | + |
| 12 | +## Requirements |
| 13 | + |
| 14 | +- [Docker Desktop](https://www.docker.com/products/docker-desktop/) |
| 15 | +- [DynamoDB Local Docker Image](https://hub.docker.com/r/amazon/dynamodb-local) |
| 16 | +- [Node v22.3.0](https://nodejs.org/en/blog/release/v22.3.0) |
| 17 | +- [AWS JavaScript SDK v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/) |
| 18 | + |
| 19 | +## Usage |
| 20 | + |
| 21 | +To start working with this project you need to first run `npm install`. |
| 22 | + |
| 23 | +### Running the tool in conjuntion with the front end. |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +### DynamoDB local |
| 28 | + |
| 29 | +This application will store all the information in an Amazon DynamoDB local instance, you will experience all the benefits from Amazon DynamoDB in your workstation. |
| 30 | + |
| 31 | +Execute the command `npm run start-db`. If this is the first time running the command your output should look like the one below. Docker will obtain the latest version for you! |
| 32 | + |
| 33 | +```shell |
| 34 | +❯ npm run start-db |
| 35 | + |
| 36 | +> basic-backend@0.0.1 start-db |
| 37 | +> echo "CID=$(docker run -p $npm_package_config_ddbport:$npm_package_config_ddbport -d amazon/dynamodb-local -jar DynamoDBLocal.jar -sharedDb)" > .ddb_cid |
| 38 | + |
| 39 | +Unable to find image 'amazon/dynamodb-local:latest' locally |
| 40 | +latest: Pulling from amazon/dynamodb-local |
| 41 | +decbb28a26fa: Pull complete |
| 42 | +4b968a8d55bd: Pull complete |
| 43 | +4f4fb700ef54: Pull complete |
| 44 | +16d147f186fa: Pull complete |
| 45 | +Digest: sha256:d7ebddeb60fa418bcda218a6c6a402a58441b2a20d54c9cb1d85fd5194341753 |
| 46 | +Status: Downloaded newer image for amazon/dynamodb-local:latest |
| 47 | +``` |
| 48 | + |
| 49 | +If you want to stop DynamoDB local execution you just need to run the command `npm run stop-db`. The long number at the end represents your docker container ID. |
| 50 | + |
| 51 | +```shell |
| 52 | +❯ npm run stop-db |
| 53 | + |
| 54 | +> basic-backend@0.0.1 stop-db |
| 55 | +> source .ddb_cid && docker stop $CID && rm .ddb_cid |
| 56 | + |
| 57 | +904e9a494f0f09acd027e33d275d3a51a05716f09cc4eace87b778bc3e65e650 |
| 58 | +``` |
| 59 | + |
| 60 | +### Working with DynamoDB tables |
| 61 | + |
| 62 | +This project consists of a To-Do application and you will be storing all the items in a DynamoDB table. First you need to create a `Notes` table, where you will store all your to-dos. |
| 63 | + |
| 64 | +Run the command `npm run create-table`. |
| 65 | + |
| 66 | +```shell |
| 67 | +❯ npm run create-table |
| 68 | + |
| 69 | +> basic-backend@0.0.1 create-table |
| 70 | +> aws dynamodb create-table --table-name $npm_package_config_ddbtable --attribute-definitions AttributeName=PK,AttributeType=S --key-schema AttributeName=PK,KeyType=HASH --billing-mode PAY_PER_REQUEST --endpoint-url http://$npm_package_config_ddbhost:$npm_package_config_ddbport --no-cli-page |
| 71 | + |
| 72 | +{ |
| 73 | + "TableDescription": { |
| 74 | + "AttributeDefinitions": [ |
| 75 | + { |
| 76 | + "AttributeName": "PK", |
| 77 | + "AttributeType": "S" |
| 78 | + } |
| 79 | + ], |
| 80 | + "TableName": "Notes", |
| 81 | + "KeySchema": [ |
| 82 | + { |
| 83 | + "AttributeName": "PK", |
| 84 | + "KeyType": "HASH" |
| 85 | + } |
| 86 | + ], |
| 87 | + "TableStatus": "ACTIVE", |
| 88 | + "CreationDateTime": "2024-07-29T10:40:09.344000-04:00", |
| 89 | + "ProvisionedThroughput": { |
| 90 | + "LastIncreaseDateTime": "1969-12-31T19:00:00-05:00", |
| 91 | + "LastDecreaseDateTime": "1969-12-31T19:00:00-05:00", |
| 92 | + "NumberOfDecreasesToday": 0, |
| 93 | + "ReadCapacityUnits": 0, |
| 94 | + "WriteCapacityUnits": 0 |
| 95 | + }, |
| 96 | + "TableSizeBytes": 0, |
| 97 | + "ItemCount": 0, |
| 98 | + "TableArn": "arn:aws:dynamodb:ddblocal:000000000000:table/Notes", |
| 99 | + "BillingModeSummary": { |
| 100 | + "BillingMode": "PAY_PER_REQUEST", |
| 101 | + "LastUpdateToPayPerRequestDateTime": "2024-07-29T10:40:09.344000-04:00" |
| 102 | + }, |
| 103 | + "DeletionProtectionEnabled": false |
| 104 | + } |
| 105 | +} |
| 106 | +``` |
| 107 | + |
| 108 | +If you run the command twice by mistake, the second time you will get an error saying that you already have a table called `Notes`. |
| 109 | + |
| 110 | +```shell |
| 111 | +❯ npm run create-table |
| 112 | + |
| 113 | +> basic-backend@0.0.1 create-table |
| 114 | +> aws dynamodb create-table --table-name $npm_package_config_ddbtable --attribute-definitions AttributeName=PK,AttributeType=S --key-schema AttributeName=PK,KeyType=HASH --billing-mode PAY_PER_REQUEST --endpoint-url http://$npm_package_config_ddbhost:$npm_package_config_ddbport --no-cli-page |
| 115 | + |
| 116 | + |
| 117 | +An error occurred (ResourceInUseException) when calling the CreateTable operation: Cannot create preexisting table |
| 118 | +``` |
| 119 | + |
| 120 | +### List all the existing tables |
| 121 | + |
| 122 | +To idenfity which tables you have created execute the command `npm run show-tables`. |
| 123 | + |
| 124 | +```shell |
| 125 | +❯ npm run show-tables |
| 126 | + |
| 127 | +> basic-backend@0.0.1 show-tables |
| 128 | +> aws dynamodb list-tables --endpoint-url http://$npm_package_config_ddbhost:$npm_package_config_ddbport |
| 129 | + |
| 130 | +{ |
| 131 | + "TableNames": [ |
| 132 | + "Notes" |
| 133 | + ] |
| 134 | +} |
| 135 | +``` |
| 136 | + |
| 137 | +### Retrieve all the items from one table |
| 138 | + |
| 139 | +To return all the elements from the `Notes` table you can run the command `npm run scan-table`. However if your table is empty you will get this output. |
| 140 | + |
| 141 | +```shell |
| 142 | +❯ npm run scan-table |
| 143 | + |
| 144 | +> basic-backend@0.0.1 scan-table |
| 145 | +> aws dynamodb scan --table-name $npm_package_config_ddbtable --endpoint-url http://$npm_package_config_ddbhost:$npm_package_config_ddbport |
| 146 | + |
| 147 | +{ |
| 148 | + "Items": [], |
| 149 | + "Count": 0, |
| 150 | + "ScannedCount": 0, |
| 151 | + "ConsumedCapacity": null |
| 152 | +} |
| 153 | +``` |
| 154 | + |
| 155 | +### Initialize the backend |
| 156 | + |
| 157 | +Finally to work with the sample express application, included in this project you will need to execute the instruction `npm run start-backend`, this process will start the express application that will be listening at port 3000. |
| 158 | + |
| 159 | +Tip: execute this command in a new terminal |
| 160 | + |
| 161 | +```shell |
| 162 | +❯ npm run start-backend |
| 163 | + |
| 164 | +> basic-backend@0.0.1 start-backend |
| 165 | +> node src/server.js |
| 166 | + |
| 167 | +Server is running on port 3000 |
| 168 | +``` |
| 169 | + |
| 170 | +## Contributing |
| 171 | + |
| 172 | +As soon as you clone this repository you need to run `pre-commit install` and before pushing any commit you need to run `detect-secrets scan > .secrets.baseline`. Failing to run this command will result in an invalid commit and it will be rejected. |
0 commit comments