thebergamo / hermes

Serverless Notification Management System

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

hermes

Serverless Notification Management System

Structure

This project follows the Go Project Layout or at least tries to.

You will find the Lambda handlers that are generated by each endpoint inside the /cmd folder.

Inside the /pkg folder we've all common usage packages + models.

Getting Started

In order to get started with this project you must have AWS SAM to be able to run the AWS Lambda environment locally. (Pre-req deps of AWS SAM are also required e.g.: Docker)

Docker compose will help you also to run AWS dependencies locally. If you prefer to not have Docker Compose, you can also use LocalStack directly.

After having the depencies resolved you need to run the following commands to start this project for development.

$ docker-compose up -d # Starts LocalStack in the background
$ make create-tables # all dynamodb tables would be created locally

$ make build && make start-api # this will build your lambdas and start aws sam.

We've also available an Insomnia collection that you can import. Check out in /docs folder.

Deployment

TBD

About

Serverless Notification Management System

License:MIT License


Languages

Language:Go 92.9%Language:Makefile 5.6%Language:Dockerfile 1.5%