kim-knudsen / dung-beetle

Random pet project featuring Fastify running on AWS

Dung Beetle serves as a pet project to elucidate the utilization of Fastify in a serverless environment. The setup is deployed on Amazon Web Services (AWS) leveraging key AWS services such as AWS Lambda and API Gateway.

The project employs a custom domain at https://dung.nissearm.dk, with the securing of its certificate undertaken by the AWS Certificate Manager so that the application can establish secure connections.

The repository takes advantage of Swagger to illustrate the documentation of the RESTful API in a simplified and presentable manner.

Furthermore, the project incorporates Github Actions for continuous integration and deployment to AWS. A new release can be conveniently scheduled directly from the GitHub UI by making use of the "releases" option.

Please note, Dung Beetle is purely for educational purposes, aiming to provide a hands-on approach to learning and understanding the integration of Fastify with serverless architecture on AWS.

Quick start

Add a basic .env file at the root of the project, containing the following suitable for local development.

HOST="localhost:3000"
SCHEME="http"

Install dependencies and run the project locally.

npm install
npm run dev