Documentation
This docs section will include documentation relevant to understand how Serverless works.
You may want to start with the "Your first service" tutorial to create, deploy, invoke and remove your very first Serverless service!
If you're interested to take a look behind the scenes you might take a look at the concepts of Serverless to understand the how Serverless is architected and works.
After that you should take a look at the different plugins which are used to deliver the functionality Serverless provides (such as service creation, deployment, removal, function invocation etc.).
Table of contents
- Concepts
- services - Understanding Serverless services
- serverless.yaml - A look at the
serverless.yamlfile - serverless.env.yaml - A look at the
serverless.env.yamlfile - event sources - Understanding different types of event sources
- plugins - How plugins work
- Tutorials
- Your first service - Create, deploy, invoke and remove your first service
- Event sources - Learn how you can extend your services functionality with event sources
- Plugins
- Core plugins
- AWS plugins
- awsCompileFunctions - Compiles the functions to CloudFormation resources
- awsCompileS3Events - Compiles the S3 events to CloudFormation resources
- awsCompileScheduledEvents - Compiles the Scheduled events to CloudFormation resources
- awsCompileApigEvents - Compiles API Gateway events to CloudFormation resources
- awsDeploy - Deploys the Serverless service to AWS
- awsInvoke - Invokes a AWS lambda function
- awsRemove - Removes the service with all it's resources from AWS
FAQ
Where do I start when I want to write apps with Serverless?
You should take a look at the tutorials where you will find different guides which will help you with your first application (there's also a "Your first service" tutorial).
I want to integrate provider X. How does this work?
You can implement your provider of choice with he help of plugins. Start by reading the plugin concept to get an overview how plugins work. After that you might want to take a look at the awsDeploy plugin which will explain to you how the AWS provider is implemented / works.
We'd recommend to take a look at the different sources of the plugins as they show implementation details and best practices which will help you integrate your provider easily.
How does Serverless work?
The concepts folder in the docs will help you understand how Serverless works. You might want to read it in this order: