https://github.com/having-fun-serverless/reminders

AWS recently released a new general-purpose scheduling service. The following repo demonstrates how to use it, by creating reminders sent via email.
https://github.com/having-fun-serverless/reminders

aws aws-lambda lambda

Last synced: about 2 months ago
JSON representation

AWS recently released a new general-purpose scheduling service. The following repo demonstrates how to use it, by creating reminders sent via email.

• Host: GitHub
• URL: https://github.com/having-fun-serverless/reminders
• Owner: having-fun-serverless
• License: apache-2.0
• Created: 2022-11-12T18:11:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-13T18:11:27.000Z (over 3 years ago)
• Last Synced: 2024-04-05T18:39:53.813Z (over 2 years ago)
• Topics: aws, aws-lambda, lambda
• Language: Python
• Homepage:
• Size: 304 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)






    


AWS Scheduler service


  


    AWS recently released a new general-purpose scheduling service. The following repo demonstrates how to use it, by creating reminders sent via email.

    


    


    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    


      High level architecture

    

    


      Getting Started

      


        
Prerequisites

        
Installation

        
Testing

      

    

    
Contributing

    
License

    
Contact

    
Logo

  


## High level architecture



    



1. Use a single Lambda to create a schedule.

2. On the desginated time, the scheduler pushes a message into SNS

3. Which in turn sends an email.

## Getting started

### Prerequisites

* Make sure your machine is ready to work with [AWS SAM](https://aws.amazon.com/serverless/sam/)

### Installation

* Clone this repository.

* Run `sam build` and then `sam deploy --guided`. Accept the default values, except for 

    * _Parameter Email - Send a reminder to this email. 

### Testing

* You can test the application manully by executing the `RemindMeFunction` Lambda directly from the console. It accepts a json with the following structure:

```

{

  "content": "Hello my friend",

  "when": "2022-11-12T23:20",

  "timezone": "Asia/Bangkok"

}

```

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## License

Distributed under the Apache License Version 2.0 License. See `LICENSE` for more information.

## Contact

Efi Merdler-Kravitz - [@TServerless](https://twitter.com/TServerless)

## Logo

The project's logo was created by Dall-E 2 with the following description _A hand drawn sketch of a sticky note floating on a cloud_

(back to top)