https://github.com/edgarrmondragon/correosmx
Serverless delivery status notifications for Correos de México
https://github.com/edgarrmondragon/correosmx
aws-lambda correos-mexico delivery-tracker serverless
Last synced: about 1 year ago
JSON representation
Serverless delivery status notifications for Correos de México
- Host: GitHub
- URL: https://github.com/edgarrmondragon/correosmx
- Owner: edgarrmondragon
- Created: 2020-04-21T14:13:24.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-21T19:35:05.000Z (almost 3 years ago)
- Last Synced: 2025-02-01T05:26:27.545Z (over 1 year ago)
- Topics: aws-lambda, correos-mexico, delivery-tracker, serverless
- Language: Python
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serveless Tracking Status Notifications
## Environment Variables
| Variable | Description |
|:------------------:|:-----------------------------------------------------------------------------------:|
| `EMAIL_TO` | Email address to send the info to |
| `EMAIL_FROM` | Email address to send the info from |
| `GUIA` | Tracking ID of the package |
| `SENDGRID_API_KEY` | You can read more [here][sendgrid]. You can send 100 emails/day with a free account |
| `PERIODO` | Year (default `2020`) |
## Installation
Requires installation of npm packages
```shell
npm install
```
## Deploy
This project uses the Serverless Framework to manage the function and its upstream resources:
```shell
serverless deploy
```
Or if you put your environment variables in a `.env` file:
```shell
env $(cat .env | xargs) serverless deploy
```
### Notes
- If you are using an [AWS named profile][profiles], you might need to do the following before deploying:
```shell
export AWS_PROFILE=myprofile
export AWS_SDK_LOAD_CONFIG=1
```
[sendgrid]: https://sendgrid.com/docs/ui/account-and-settings/api-keys/
[profiles]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html