Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/perkzen/serverless-aws-node
https://github.com/perkzen/serverless-aws-node
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/perkzen/serverless-aws-node
- Owner: perkzen
- Created: 2024-05-27T20:16:43.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-29T14:10:13.000Z (7 months ago)
- Last Synced: 2024-05-29T22:56:07.720Z (7 months ago)
- Language: JavaScript
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎉 Car Management System - Serverless
This project demonstrates how to develop a serverless backend for an car management system using AWS Lambda, DynamoDB, and SNS with the Serverless Framework. The backend is developed and tested locally using Localstack.
## 🚀 Project Setup
### Step 1: Install Node.js and Serverless Framework
Ensure you have Node.js installed. Then, install the Serverless Framework globally:
```console
npm install -g serverless
```
### Step 2: Create a Serverless Project
Create a new Serverless project:
```console
serverless create --template aws-nodejs --path car-management-system
cd car-management-system
npm init -y
npm install aws-sdk jsonwebtoken bcryptjs serverless-offline serverless-localstack
```
## ⚙️ Configuration
### Step 3: Configure `serverless.yml`
Update your `serverless.yml` to configure DynamoDB and SNS locally using Localstack, and include serverless-offline for local API Gateway.
See the full `serverless.yml` configuration [here](serverless.yml).
## 📝 Lambda Functions
### Step 4: Create Lambda Functions
Create a `handler.js` file with the Lambda functions to handle the API endpoints. You can find the implementation details [here](handler.js).
## 🛠 Local Development
### Step 5: Start Localstack
Ensure you have Localstack and Docker installed and running.
Start Localstack:
```console
localstack start
```
Create DynamoDB Table and SNS Topic Locally:
```bash
aws --endpoint-url=http://localhost:4566 dynamodb create-table --table-name car-management-system-cars --attribute-definitions AttributeName=id,AttributeType=S --key-schema AttributeName=id,KeyType=HASH --provisioned-throughput ReadCapacityUnits=1,WriteCapacityUnits=1 --region us-east-1
aws --endpoint-url=http://localhost:4566 sns create-topic --name carNotification --region us-east-1
```
### Step 6: Start Serverless Offline
Start the Serverless Offline plugin to run the API locally:
```console
serverless offline --stage local
```
### Step 7: Test Locally
Use Postman or curl to test the endpoints locally:
### 👨💻 Login:
```bash
curl -X POST http://localhost:3000/local/login -H "Content-Type: application/json" -d '{"username":"admin","password":"admin"}'
```
#### 🚀 Create Car:
```bash
curl -X POST http://localhost:3000/local/cars -H "Content-Type: application/json" -H "Authorization: Bearer " -d '{"brand":"VW","model":"Polo"}'
```
#### 🚗 Get All Cars:
```bash
curl http://localhost:3000/local/cars
```
#### 🔍 Get Event by ID:
```bash
curl http://localhost:3000/local/cars/{id}
```
#### ✏️ Update Event:
```bash
curl -X PUT http://localhost:3000/local/cars/{id} -H "Content-Type: application/json" -H "Authorization: Bearer " -d '{"title":"Updated Event","description":"This is an updated event.","date":"2024-06-20"}'
```
#### ❌ Delete Event:
```bash
curl -X DELETE http://localhost:3000/local/cars/{id} -H "Authorization: Bearer "
```
### 🕰 Invoke Scheduled Task Manually:
```bash
serverless invoke local --function scheduledTask
```
### 📡 Publish a Message to SNS Topic:
```bash
aws --endpoint-url=http://localhost:4566 sns publish --topic-arn arn:aws:sns:us-east-1:000000000000:carNotification --message "Test SNS message" --region us-east-1
```