https://github.com/serverless/workshops
Companion repo for workshops with instructions and code examples
https://github.com/serverless/workshops
Last synced: about 2 months ago
JSON representation
Companion repo for workshops with instructions and code examples
- Host: GitHub
- URL: https://github.com/serverless/workshops
- Owner: serverless
- Created: 2017-10-27T18:18:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-17T18:08:25.000Z (over 7 years ago)
- Last Synced: 2025-04-18T07:51:35.928Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 5
- Watchers: 29
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serverless Workshops
A companion repository for workshops with instructions and code examples.
## Slides
https://drive.google.com/file/d/13D6U2yMwDrg5BJQQPVx_CG2AdF5dA_CV/view?usp=sharing
## Pre-requisites
These steps need to be completed before the workshop:
* Text editor installed
* NPM and NodeJS 6.10 or later installed
* Git 2.0.0 or later installed
* Curl installed
* Serverless Framework installed
* AWS account setup & credentials configured
### Install NPM and NodeJS
[Download](https://nodejs.org/en/download/) appropriate OS package and install it on your machine.
Test to see that you have `npm` and `node` installed properly:
```
$ npm -v
$ node -v
```
### Install Git
[Download](https://git-scm.com/downloads) appropriate OS package and install it on your machine.
Test to see that you have `git` installed properly:
```
$ git version
```
### Install Curl
[Download](https://curl.haxx.se/download.html) appropriate OS package and install it on your machine.
Test to see that you have `curl` installed properly:
```
$ curl --version
```
### Install Serverless Framework
```
$ npm install -g serverless
```
Test to see that you have Serverless Framework installed properly:
```
$ serverless version
```
### AWS Setup
Follow instructions in the [tutorial](https://serverless.com/provider-setup/#get-started) to:
* Setup AWS account
* Configured AWS credentials with the Serverless Framework
**Note**: Each workshop participant needs to setup their own AWS account.
## Labs Code Examples
As part of the workshop, we will do the following exercises.
### Exercise 1: Hello World - creating the hello world app
Create the app from scratch:
```
$ cd
$ serverless create --template hello-world --path hello-sls
$ sls deploy
```
### Exercise 2: Hello World - dynamic app
Open the `handler.js` file in your text editor and update it with the following code:
```
'use strict';
module.exports.helloWorld = (event, context, callback) => {
let dynamicMsg = 'Hello Unknown!';
// check for GET params and use if available
if (event.queryStringParameters && event.queryStringParameters.name) {
dynamicMsg = `Hello ${event.queryStringParameters.name}!`;
}
const response = {
statusCode: 200,
headers: {
'Access-Control-Allow-Origin': '*', // Required for CORS support to work
},
body: JSON.stringify({
// message: 'Go Serverless v1.0! Your function executed successfully!',
message: dynamicMsg,
input: event,
}),
};
callback(null, response);
};
```
Then, deploy the new code changes:
```
$ sls deploy
```
### Exercise 3: Users Service - install project
Let's install the `users-service` project from the Github repo:
```
// cd into your working folder
$ cd
// install the project
$ sls install --url https://github.com/serverless/workshops/tree/master/labs/users-service
// cd into the users-service folder
$ cd users-service
```
Then, deploy the new project:
```
$ sls deploy
```
### Exercise 4: Users Service - calling the API
**Note**: We need to fetch the urls for the deployed endpoints, and replace the urls in the following code fragments, before we run them.
#### Fetch the urls for the endpoints
```
$ sls info
```
#### Get User
Go to the browser and type in the url:
`https://XXXXXXXXXX.execute-api.us-east-1.amazonaws.com/dev/users/1`
Or you can `curl` it on the command line:
```
$ curl -v -X GET https://XXXXXXXXXX.execute-api.us-east-1.amazonaws.com/dev/users/1
```
#### Create User
```
$ curl -v -X POST \
https://XXXXXXXXXX.execute-api.us-east-1.amazonaws.com/dev/users/create \
-d '{"user": {"name":"John Doe", "email":"[email protected]"}}'
```
#### Delete User
```
$ curl -v -X DELETE https://XXXXXXXXXX.execute-api.us-east-1.amazonaws.com/dev/users/1
```
### Exercise 5: Users Service - other CLI commands
#### Fetch the project urls
```
$ sls info
```
#### Tailing logs
Let's simulate an error and see it in the logs.
Tail the log for errors:
```
$ cd /users-service
$ sls logs -f get -t
```
Go to the browser and type in the url:
`https://XXXXXXXXXX.execute-api.us-east-1.amazonaws.com/dev/users/999`
Or you can `curl` it on the command line:
```
$ curl -v -X GET https://XXXXXXXXXX.execute-api.us-east-1.amazonaws.com/dev/users/999
```
#### Fetch the project metrics
```
$ sls metrics
```
#### Invoke a function locally
```
$ sls invoke local -f get -p \
users/test/event.get.json
```
#### Invoke a function remotely
```
$ sls invoke -f get -p \
users/test/event.get.json --log
```