Messageraft
📝 Table of Contents
🧐 About
Messageraft is a notification gateway where you have a single API to send multiple types of notification.
By configuring Messageraft with your 3rd party provider API keys you can use this service to send your message and Messageraft does the rest
Currently supported providers out of the box: Sendgrid, Twilio and Slack
You can also improve your email testing by using maildev in combination with the maildev provider we created for you!
🏁 Getting Started
Step 1 - Install CLI
$ npm i -g @messageraft/cli
OR
$ yarn global add @messageraft/cliStep 2 - Run init command
Main question the CLI will ask is to select the providers you want to install
$ messageraft init <directory-name>Step 3 - Setup ENV variables
Last step before spinning up the server is to setup the environment variables. Check config/env/development.example.env on necessary details needed based on the providers you selected
IMPORTANT: Don't forget to rename development.example.env -> development.env
Step 4 - Start server and send request
The server was created using Nest JS but there is nothing you need to touch really.
# Start server locally
$ npm run start:dev
OR
$ yarn start:devNOTE: Ideally if you are going to deploy then you should first build the server before running, also creating a production.env file is required
Step 5 - Send a message
curl --request POST \
--header "Content-Type: application/json" \
--data '{
"data": {
"to": "xyz@gmail.com",
"from": "hello@messageraft.com",
"subject": "Testing",
"html": "<p>Hello <strong>World</strong></p>"
}
}' \
http://localhost:3000/message/send/sendgrid
✍️ API Documentation
Messageraft is using Swagger to host the documentation, simply navigate to
http://localhost:3000/api
to view the documentation