Build and deploy serverless Swift applications in a Breeze!
Breeze is a command-line tool that makes it easy to create, build, and deploy serverless applications written in Swift. It provides ready-to-use templates that you can customize to fit your needs, so you can focus on writing your application's logic instead of wrestling with project setup and configuration.
Building serverless applications can be complex. You have to deal with infrastructure as code, deployment scripts, and a whole new set of tools and services. Breeze simplifies this process by providing:
- Ready-to-use templates: Get started quickly with pre-built templates for common serverless use cases.
- Swift on the server: Write your backend code in the same language you use for your iOS, macOS, and other Apple platform apps.
- Open and customizable: All the generated code and configurations are open source and can be easily modified to fit your specific needs.
- Streamlined workflow: Breeze provides a set of simple commands to generate, build, deploy, and manage your serverless applications.
Serverless computing allows you to build and run applications without thinking about servers. It offers:
- Reduced operational overhead: No servers to provision or manage.
- Automatic scaling: Your application scales automatically with the number of requests.
- Cost-effectiveness: You only pay for the resources your application consumes.
Swift is a modern, fast, and safe programming language that is now a great choice for server-side development. It offers:
- High performance: Swift is a compiled language that is known for its speed and efficiency.
- Concise and readable syntax: Swift's clean syntax makes it easy to write and maintain code.
- Strongly typed: Swift's strong type system helps you catch errors at compile time, not at runtime.
Breeze currently offers the following templates:
A complete serverless REST API with CRUD operations, using API Gateway, Lambda, and DynamoDB.
- Learn more: Docs/GenerateLambdaAPI.md
- Get started:
swift run breeze generate-lambda-api --help - Watch the talk: Serverless in Swift Like a Breeze – Andrea Scuderi (NSLondon 2023.2)
- View the slides: Slides
A serverless webhook that can receive and process GitHub events, with signature verification.
- Learn more: Docs/GenerateGithubWebhook.md
- Get started:
swift run breeze generate-github-webhook --help
A simple serverless webhook with GET and POST endpoints.
- Learn more: Docs/GenerateWebhook.md
- Get started:
swift run breeze generate-webhook --help
Make sure you have the prerequisites installed, including Swift, Docker, and the Open Source Serverless framework. Then, you can start using Breeze to generate your serverless applications. It only takes a few steps to get your first serverless Swift application up and running with Breeze:
- Generate a project:
swift run breeze generate-lambda-api --target-path ../MyAwesomeAPI --config-file Configs/MyAwesomeAPI.yml
- Customize the code: Open the generated project in your favorite editor and start writing your application's logic.
- Build and deploy:
cd ../MyAwesomeAPI ./build.sh ./deploy.sh
That's it! Your serverless application is now live.
Breeze provides a set of command-line interface (CLI) commands to help you generate your serverless applications:
swift run breeze generate-lambda-api: Generate a new serverless REST API.swift run breeze generate-github-webhook: Generate a new GitHub webhook.swift run breeze generate-webhook: Generate a new generic webhook.
Help for each command can be accessed by appending --help to the command, e.g. swift run breeze generate-lambda-api --help.
Breeze provides a simple and efficient workflow for developing serverless applications in Swift:
- Generate: Create a new project from a template.
- Customize: Modify the generated code to implement your application's logic.
- Build: Use the
build.shscript to compile your code and package it for deployment. - Deploy: Use the
deploy.shscript to deploy your application to AWS. - Update: Use the
update.shscript to deploy changes to your application. - Remove: Use the
remove.shscript to delete your application from AWS.
- Swift 5.7 or later
- Docker
- Open Source Serverless
- An AWS account with the necessary credentials to deploy a Serverless stack.
make
Breeze is designed to minimize costs by leveraging serverless architecture. However, you should be aware of the following potential costs when running your serverless applications:
- AWS Lambda: You pay for the compute time your functions consume.*
- API Gateway: You pay for the number of API calls and data transfer. *
- DynamoDB: You pay for the read/write capacity and storage used by your database.*
- S3: You pay for the storage used by your application assets.*
- IAM: You may incur costs for IAM roles and policies, depending on your usage. *
- CloudWatch: You may incur costs for logging and monitoring your application. *
Estimated costs can vary based on your application's usage patterns, so it's important to monitor your AWS billing and optimize your resources accordingly. Estimation of costs can be done using the AWS Pricing Calculator: AWS Pricing Calculator
Free tier usage is available for many AWS services, so you can get started without incurring costs.
- Low Traffic: If your API handles fewer than 1 million requests per month and performs simple database operations, your total monthly bill will almost certainly be $0.00, thanks to the generous AWS Free Tier for every component.
Note: The AWS Free Tier is subject to change, and it's important to review the AWS Free Tier page for the most up-to-date information. We are not responsible for any costs incurred while using Breeze or any of its generated applications. Please ensure you understand the pricing of the AWS services you use.
Contributions are welcome! If you find any issues or have ideas for new features, please open an issue or submit a pull request.