events-api is a practical and effective tool for managing events, built using modern technologies including Node.js 18.x, TypeScript, Serverless Framework, and DynamoDB. This combination of technologies ensures a scalable, efficient, and easy-to-maintain API.
Key Features:
- Built with Node.js 18 and TypeScript: Offers a stable and scalable backend with the added benefits of TypeScript's strong typing.
- Serverless Framework Integration: Ensures easy deployment and lower maintenance overhead, making the API cost-effective and scalable.
- DynamoDB for Data Storage: Leverages AWS DynamoDB for reliable and fast data storage, ideal for handling event data.
- Event CRUD Operations: Supports creating, reading, updating, and deleting events with ease.
- Simple Event Tracking: Manage essential details like event names, types, dates, and locations.
- Data Validation: Includes basic validation to ensure the accuracy and integrity of event data.
- Ease of Use: Designed to be straightforward and user-friendly, making it accessible for developers of varying skill levels.
This API is a perfect solution for developers looking for a simple yet efficient way to handle event management in their applications, with the backing of robust and modern technologies.
This project uses the following Serverless plugins:
- serverless-offline: Simulates AWS Lambda and API Gateway locally, without the need to manage any servers.
- serverless-dynamodb: Provides a local DynamoDB instance for testing your application's DynamoDB tables. Requires JRE 6 or Dynamodb Docker image.
- serverless-webpack: Bundles your code and dependencies into a single file to be deployed.
- serverless-auto-swagger: Generates Swagger documentation for your API, utilizes functions.yml response definitions to populate types.
- serverless-esbuild: Enables Typescript in your serverless project.
- AWS Credentials ready to go
- Node.js 18.x
- Java Runtime Engine (JRE) version 6.x or newer OR docker CLI client
- Install dependencies with:
npm i
npm i -g serverless
serverless dynamodb install
- Then initialize husky hooks with:
npm prepare
- Run to connect with Serverless dashboard account:
serverless
To run the application in localhost you must have:
- Completed the Installation steps
- JRE setup (6.x or newer)
serverless offline start
or to any stage with:
serverless deploy -stage your-stage
After running deploy, you should see output similar to:
Deploying aws-node-express-dynamodb-api-project to stage dev (us-east-1)
✔ Service deployed to stack aws-node-express-dynamodb-api-project-dev (196s)
endpoint: ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com
functions:
api: aws-node-express-dynamodb-api-project-dev-api (766 kB)Our amazing contributors:
