-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
85 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,93 @@ | ||
| [](https://travis-ci.org/awslabs/serverless-application-model) | ||
| [](https://badge.fury.io/py/aws-sam-translator) | ||
| [](https://codecov.io/gh/awslabs/serverless-application-model) | ||
|
|
||
|  | ||
| <p align="center"> | ||
| </p> | ||
|
|
||
| # AWS Serverless Application Model (AWS SAM) | ||
| You can use SAM to define serverless applications in simple and clean syntax. | ||
|
|
||
| This GitHub project is the starting point for AWS SAM. It contains the SAM specification, the code that translates SAM templates into AWS CloudFormation stacks, general information about the model, and examples of common applications. | ||
|  | ||
|  | ||
|
|
||
| The AWS Serverless Application Model (SAM) is an open-source framework for building serverless applications. | ||
| It provides shorthand syntax to express functions, APIs, databases, and event source mappings. | ||
| With just a few lines of configuration, you can define the application you want and model it. | ||
|
|
||
| [](https://www.youtube.com/watch?v=1dzihtC5LJ0) | ||
|
|
||
| ## Get Started | ||
|
|
||
| To get started with building SAM-based applications, use the SAM CLI. SAM CLI provides a Lambda-like execution | ||
| environment that lets you locally build, test, debug, and deploy applications defined by SAM templates. | ||
|
|
||
| * [Install SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) | ||
| * [Build & Deploy a "Hello World" Web App](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-quick-start.html) | ||
| * [Install AWS Toolkit](https://aws.amazon.com/getting-started/tools-sdks/#IDE_and_IDE_Toolkits) to use SAM with your favorite IDEs. | ||
|
|
||
|
|
||
| **Next Steps:** Learn to build a more complex serverless application. | ||
| * [Extract text from images and store in a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-s3.html) using Amazon S3 and Amazon Rekognition services. | ||
| * [Detect when records are added to a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-ddb.html) using Amazon DynamoDB database and asynchronous stream processing. | ||
|
|
||
|
|
||
| **Detailed References:** Explains SAM commands and usage in depth. | ||
| * [CLI Commands](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-command-reference.html) | ||
| * [SAM Template Specification](https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md) | ||
| * [Policy Templates](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-policy-templates.html) | ||
|
|
||
| ## Why SAM | ||
|
|
||
| + **Single\-deployment configuration**\. SAM makes it easy to organize related components and resources, and operate on a single stack\. You can use SAM to share configuration \(such as memory and timeouts\) between resources, and deploy all related resources together as a single, versioned entity\. | ||
|
|
||
| + **Local debugging and testing**\. Use SAM CLI to locally build, test, and debug SAM applications on a Lambda-like execution environment. It tightens the development loop by helping you find & troubleshoot issues locally that you might otherwise identify only after deploying to the cloud. | ||
|
|
||
| + **Deep integration with development tools**. You can use SAM with a suite of tools you love and use. | ||
| + IDEs: [PyCharm](https://aws.amazon.com/pycharm/), [IntelliJ](https://aws.amazon.com/intellij/), [Visual Studio Code](https://aws.amazon.com/visualstudiocode/), [Visual Studio](https://aws.amazon.com/visualstudio/), [AWS Cloud9](https://aws.amazon.com/cloud9/) | ||
| + Build: [CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/) | ||
| + Deploy: [CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/), [Jenkins](https://wiki.jenkins.io/display/JENKINS/AWS+SAM+Plugin) | ||
| + Continuous Delivery Pipelines: [CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/) | ||
| + Discover Serverless Apps & Patterns: [AWS Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/) | ||
|
|
||
| + **Built\-in best practices**\. You can use SAM to define and deploy your infrastructure as configuration. This makes it possible for you to use and enforce best practices through code reviews. Also, with a few lines of configuration, you can enable safe deployments through CodeDeploy, and can enable tracing using AWS X\-Ray\. | ||
|
|
||
| + **Extension of AWS CloudFormation**\. Because SAM is an extension of AWS CloudFormation, you get the reliable deployment capabilities of AWS CloudFormation\. You can define resources by using CloudFormation in your SAM template\. Also, you can use the full suite of resources, intrinsic functions, and other template features that are available in CloudFormation\. | ||
|
|
||
| ## What is this Github repository? 💻 | ||
|
|
||
| This GitHub repository contains the SAM Specification, the Python code that translates SAM templates into AWS CloudFormation stacks and lots of examples applications. | ||
| In the words of SAM developers: | ||
|
|
||
| > SAM Translator is the Python code that deploys SAM templates via AWS CloudFormation. Source code is high quality (95% unit test coverage), | ||
| with tons of tests to ensure your changes don't break compatibility. Change the code, run the tests, and if they pass, you should be good to go! | ||
| Clone it and run `make pr`! | ||
|
|
||
| ## Contribute to SAM | ||
|
|
||
| We love our contributors ❤️ We have over 100 contributors who have built various parts of the product. | ||
| Read this [testimonial from @ndobryanskyy](https://www.lohika.com/aws-sam-my-exciting-first-open-source-experience/) to learn | ||
| more about what it was like contributing to SAM. | ||
|
|
||
| Depending on your interest and skill, you can help build the different parts of the SAM project; | ||
|
|
||
| **Enhance the SAM Specification** | ||
|
|
||
| Make pull requests, report bugs, and share ideas to improve the full SAM template specification. | ||
| Source code is located on Github at [awslabs/serverless-application-model](https://github.com/awslabs/serverless-application-model). | ||
| Read the [SAM Specification Contributing Guide](https://github.com/awslabs/serverless-application-model/blob/master/CONTRIBUTING.md) | ||
| to get started. | ||
|
|
||
| **Strengthen SAM CLI** | ||
|
|
||
| Add new commands or enhance existing ones, report bugs, or request new features for the SAM CLI. | ||
| Source code is located on Github at [awslabs/aws-sam-cli](https://github.com/awslabs/aws-sam-cli). Read the [SAM CLI Contributing Guide](https://github.com/awslabs/aws-sam-cli/blob/develop/CONTRIBUTING.md) to | ||
| get started. | ||
|
|
||
| **Update SAM Developer Guide** | ||
|
|
||
| The SAM specification and implementation are open sourced under the Apache 2.0 license. The current version of the SAM specification is available at [AWS SAM 2016-10-31](versions/2016-10-31.md). | ||
| [SAM Developer Guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/index.html) provides comprehensive getting started guide and reference documentation. | ||
| Source code is located on Github at [awsdocs/aws-sam-developer-guide](https://github.com/awsdocs/aws-sam-developer-guide). | ||
| Read the [SAM Documentation Contribution Guide](https://github.com/awsdocs/aws-sam-developer-guide/blob/master/CONTRIBUTING.md) to get | ||
| started. | ||
|
|
||
| Documentation about using AWS SAM to define, test, and deploy serverless applications is available at [AWS Serverless Application Model Developer Guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html). | ||
| ### Join the SAM Community on Slack | ||
| [Join the SAM developers channel (#samdev)](https://join.slack.com/t/awsdevelopers/shared_invite/enQtMzg3NTc5OTM2MzcxLTdjYTdhYWE3OTQyYTU4Njk1ZWY4Y2ZjYjBhMTUxNGYzNDg5MWQ1ZTc5MTRlOGY0OTI4NTdlZTMwNmI5YTgwOGM/) on Slack to collaborate with fellow community members and the AWS SAM team. | ||
|
|
||
| ## Contributing new features and enhancements to SAM | ||
| You can build serverless applications faster and further simplify your development of serverless applications by defining new event sources, new resource types, and new parameters within SAM. Additionally, you can modify SAM to integrate it with other frameworks and deployment providers from the community for building serverless applications. | ||
|
|
||
| [Read the Development Guide](DEVELOPMENT_GUIDE.rst) for in-depth information on how to start making changes. | ||
|
|
||
| [Join the SAM developers channel (#samdev) on Slack](https://join.slack.com/t/awsdevelopers/shared_invite/enQtMzg3NTc5OTM2MzcxLTdjYTdhYWE3OTQyYTU4Njk1ZWY4Y2ZjYjBhMTUxNGYzNDg5MWQ1ZTc5MTRlOGY0OTI4NTdlZTMwNmI5YTgwOGM/) to collaborate with fellow community members and the AWS SAM team. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.