Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siddh34/email-server
Email Server Using Plunk & Resend
https://github.com/siddh34/email-server
nestjs nodejs resend-email-api swagger useplunk
Last synced: 4 days ago
JSON representation
Email Server Using Plunk & Resend
- Host: GitHub
- URL: https://github.com/siddh34/email-server
- Owner: siddh34
- Created: 2024-08-25T07:55:02.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T14:00:51.000Z (3 months ago)
- Last Synced: 2024-08-27T12:02:08.202Z (3 months ago)
- Topics: nestjs, nodejs, resend-email-api, swagger, useplunk
- Language: TypeScript
- Homepage:
- Size: 434 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Emailer
Swagger docs at `/api` endpoint
## ENV To Setup
```txt
RESEND_API_KEY
PLUNK_API_KEY
```
## Description
* Contains two email providers for emailing Resend and usePlunk
* Has a retry machanism
* Has status tracking of emails sent or not sent
* Has duplicate send prevention
## Project setup
local setup & start
```bash
pnpm install
pnpm run start
```
## Run on Docker
```bash
docker compose build
docker compose up -d
```
## Compile and run the project
```bash
# development
$ pnpm run start
# watch mode
$ pnpm run start:dev
# production mode
$ pnpm run start:prod
```
## Run tests
```bash
# unit tests
$ pnpm run test
# test coverage
$ pnpm run test:cov
```
## Resources
* Build in [nestjs](https://docs.nestjs.com/)
* Read the [Resend docs](https://resend.com/docs/introduction)
* Read the [useplunk docs](https://www.useplunk.com/)