In this workshop you will deploy a simple serverless application using Stackery. The application is a unicorn ride hailing service called Wild Rydes. The Wild Rydes application is a three tier web application composed of a frontend web application, a RESTful web services backend API, and a NoSQL data layer. This workshop will also cover common topics for building serverless applications like secrets management and user authentication, authorization, and management.
The application architecture uses the following AWS services.
- Lambda - Backend API compute
- API Gateway - Backend HTTP interface
- DynamoDB - NoSQL datastore
- S3 - Object store for hosting frontend.
- AWS CodeBuild for deploying static website content
- Cognito - user management, authentication, and authorization.
Before you begin this workshop please make sure you have completed the steps in the Setup / Prerequisites section of this documentation.
- Frontend
- User Management
- Environment Parameters & Secrets
- Backend API
- Production Deployment
- Application Observability
- Distributed Tracing & Troubleshooting
- Monitoring
- Performance Monitoring
To complete this workshop you will need the following:
- Software:
- A text editor or programming IDE
- Node.js + Node Package Manager (npm)
- The AWS CLI
- The AWS SAM CLI
- Accounts
- AWS
- Stackery
- Lumigo
Be sure the laptop you are using during the workshop can run a terminal or shell. For example, if you are using a Chromebook, make sure it has the ability to boot into Linux. MacOS, Linux, or Windows laptops should work without any changes required.
At a minimum you will need to create a Stackery account. Follow the instructions below to setup what you need to get started and complete this workshop.
Create an AWS account if you do not already have one. The workshop's application is built to run in AWS.
To create an AWS account, click on the link below and follow the signup screens. You'll provide your email address, create a password, and give your account a name.
You will need to enter a credit card to complete account setup. Your card will not be charged unless your account exceeds the free tier usage limits. All of the resources you will launch as part of this workshop are eligible for the AWS free tier if your account is less than 12 months old. See the AWS Free Tier page for more details.
Next, create a Stackery account and link your AWS account to it.
If you are doing the workshop together with team members who will be sharing an AWS account, have only one team member follow this step to create an account. Once the account is set up, go to User Settings in Stackery and click Invite New User to invite the remaining team members. Each team member can still connect their own Git account, as well as additional AWS accounts as needed.
Click on the link below to bring you to the Stackery signup page.
Once sign up is completed you'll be redirected to the application's welcome page. While on the welcome page, check your mail for an email verification message. You'll need to verify your email before you proceed. Once you have completed this, click the Next Step button.
Now link your AWS account to Stackery. Click on the Link my AWS account button.
This will open up the CloudFormation console (you may be required to login first) with pre-populated parameters. In order to proceed, click the check mark saying you acknowledge the creation of IAM resources, then click the Create stack button. This process will take a few minutes as CloudFormation creates the appropriate roles.
We will be using the Stackery CLI to handle stack creation and deployment.
Follow the instructions for your operating system in the setup to download and install the Stackery CLI. Complete the setup by entering:
stackery loginOnce you have completed all these steps you should be ready to use Stackery!
Navigate to the stack list page in Stackery: https://app.stackery.io/stacks. Next, select a Git provider to store the stack we're creating. You can name the stack anything you like, say stackery-wild-rydes. Make sure to create a new repo, provide any further Git provider-specific settings, and start from a Blank template.
In your terminal or IDE, clone your new git repo:
# Fill in your repo URL below, like git@github.com:stackery/stackery-wild-rydes.git
git clone <repo URL>This will create a directory called stackery-wild-rydes that includes a blank template.yaml file. The template.yaml is an AWS SAM formatted template in which we will create our infrastructure-as-code.
If you have VS Code you can install the Stackery extension which makes template editing a breeze. Click here to open the extension in the marketplace and install it.
To start editing the template, either:
- In VS Code with the Stackery extension, open the template.yaml file and click the Stackery icon in the top right toolbar
cdto thestackery-wild-rydesdirectory you just created, and enter:stackery edit
You may see a login screen:
Log in with your Stackery credentials, then you will be redirected to the blank canvas:
That's where we'll start building our app architecture in the next step.
Proceed to the next module in this workshop:
You may see the following error when cloning the repo in your Mac terminal: xcrun: error: invalid active developer path. This means that you need XCode installed on your machine (even though we won't be using it in this workshop). To install the necessary tools to run git in the terminal, enter xcode-select --install and try cloning again when the installation completes.
If your GitHub account has two-factor authentication enabled, you will need to create an access token to log into your account in the terminal. Go to github.com/settings/profile, click Developer Settings, then Personal access tokens and generate a new token. This will be your password when signing in to GitHub in the terminal.
There are a couple of possible causes of CORS errors in this app. One would be not enabling CORS in the API Gateway, which is covered in the Add a Rest API resource step.
The other is forgetting to copy the new function code for the RequestUnicorn function, which is covered in the Update RequestUnicorn Function step.
If you have completed both steps and are still getting a CORS error in the console, please notify a team member and we'll help you debug.
There are several reasons a change set can fail to prepare or deploy, including template formatting errors or lacking the required environment parameters. If your stack fails to prepare or deploy at any point during the workshop, please grab a Stackery team member - we'll be happy to help you out!