@effect-ak/effortless
v0.0.2
Published
Effortless serverless deployment on AWS with minimal configuration
Downloads
130
Readme
Effortless (serverless made simple)
Effortless is a tool for rapid and efficient deployment of applications in AWS. Unlike traditional solutions such as Serverless or CloudFormation, Effortless uses the AWS SDK directly, significantly speeding up the process of setting up and deploying projects.
Key Features:
- Quick Start: Minimal setup time to start a new project.
- Direct use of AWS SDK: Abandoning CloudFormation in favor of direct SDK calls.
- Flexibility: Easy creation and configuration of API Gateway, Lambda functions, authorization, and other AWS services.
- Performance: Significant reduction in deployment time compared to traditional solutions.
Why Effortless?
Traditional tools like CloudFormation and Serverless often require lengthy setup and have complex internal mechanisms. Effortless offers an alternative approach, focusing on speed and ease of use.
How It Works:
Effortless provides a high-level API for working with various AWS services, such as:
- API Gateway
- Lambda
- Authorization
- Integrations with other AWS services
Using this tool, developers can quickly create and deploy complex applications in AWS without the need to delve deep into infrastructure details.
Target Audience:
- Developers working with Node.js and TypeScript
- Teams looking for quick deployment solutions in AWS
- Projects requiring flexibility and speed in infrastructure setup
Current Status:
The project is in active development. We are open to feedback and suggestions for improving functionality.
This project aims to simplify and accelerate the process of deploying applications in AWS, providing developers with a powerful and flexible tool for working with cloud infrastructure.
Why This tool?
This tool is designed to simplify the process of creating and deploying serverless applications on AWS. It addresses common challenges faced by developers when working with more complex tools like CloudFormation, Serverless Framework, or SAM.
Key Benefits:
Simplified Setup: Focus on a curated set of AWS resources commonly used in serverless architectures, reducing the learning curve.
Rapid Development: Quickly bootstrap your serverless project with pre-configured templates and sensible defaults.
Streamlined Workflow: Concentrate on writing business logic in Lambda functions instead of spending time on infrastructure configuration.
Opinionated Defaults: Benefit from best practices baked into the framework, based on real-world serverless application development experience.
Reduced Cognitive Load: Work with a limited set of AWS services tailored for event-driven architectures, making it easier to understand and manage your application.
Team Standardization: Enforce consistent patterns and practices across your development team when building serverless applications.
Fast Deployment: Deploy your serverless application with a single command, abstracting away the complexities of AWS resource management.
Who Is It For?
- Developers new to AWS serverless architecture who want a gentle learning curve
- Teams looking to standardize their approach to building serverless applications
- Experienced developers who want to reduce boilerplate and focus on business logic
- Projects that require quick prototyping and iteration of serverless applications
By providing a more focused and opinionated approach to serverless development on AWS, this framework aims to increase productivity and reduce the time-to-market for your applications.
Effortless Commands
Effortless supports the following commands to manage your AWS serverless infrastructure:
bootstrap
This command creates AWS resources necessary for running your application on a serverless architecture.
Usage: Effortless bootstrap
Resources created:
- IAM roles
- Roles for Lambda functions
- Roles for API Gateway
- HTTP API Gateway
- Lambda authorizers for API endpoints
- Integrations with SQS for event-driven architecture
- Direct Lambda integrations for API endpoints
- Lambda functions
- As specified in your Effortless configuration
- SQS queue
- Acts as an event bus containing business events
Note: The exact resources created will depend on your project's configuration.
destroy (TODO)
This command is planned but not yet implemented. When available, it will remove all resources created by Effortless.
Usage: Effortless destroy
Planned functionality:
- Identify all resources created through Effortless
- Safely remove these resources from your AWS account
- Clean up any local configuration files related to the destroyed resources
Note: This command is not yet available and is marked for future development.
For more detailed information about each command and its options, please refer to the Effortless documentation or use the built-in help command (once implemented).