aws-samples / aws-dog-no-dog Goto Github PK

Dog no Dog

Dog no Dog is a sample application to showcase how to build a minimum viable product with serverless technologies on AWS.

With the Dog no Dog application, users can submit a picture and the backend should check if there is a dog in it. After this, the user has the possibility to leave a feedback if the picture contains a dog or not.

The standard frontend implementation uses a mock that will always returns that there is a dog in the picture.

This repository has two backend folders:

• backend: The backend only contains helpers (Makefile, boilerplate code for your AWS Lambda functions) and it is up to you to implement the backend.
• backend_complete: A complete implementation of both the frontend and backend for reference. You will need to overwrite the backend folder with this one and uncomment lines in the amplify.yml file to deploy the backend with AWS Amplify Console.

As this is meant as a challenge and hands-on workshop with limited help, a few hints are available below but you are encouraged to try things by yourself as much as possible.

If you are new to Serverless applications on AWS or are looking for a more guided workshop to learn about Serverless technologies, you should look at the AWS Serverless Workshops.

How to get started

The project consist of a Vue.js 2 frontend and boilerplate to create a serverless backend using AWS SAM.

Frontend

To install the necessary libraries for Vue.js and get started, you will need to have NPM installed and run the following commands:

# From the root of this repository

# Install the Vue.js CLI
npm install --global @vue/cli @vue/cli-service

# Install packages for this project
npm install

# Run the Vue app locally
npm run serve

For the backend, you will need to install the AWS CLI, the AWS SAM CLI and Make.

S3 bucket

First, you will need to create an S3 bucket.

# From the root of this repository

# Create a new S3 bucket to store code artifacts. Please note that S3 buckets
# have to be globally unique.
aws s3api create-bucket --bucket "your-bucket-name"

After that, you should edit backend/Makefile and amplify.yml to change the S3 Bucket name from "dog-no-dog-artifacts" to your bucket name.

Backend

The backend comes with a Makefile that contains the following targets:

# Deploy log processing infrastructure to generate metrics
make --directory backend log-processing

# Deploy the backend
# This runs the targets 'package', 'deploy' and 'endpoint' in sequence.
# Equivalent to 'make --directory backend all'. By default, this will deploy to
# a 'dev' environment.
make --directory backend

# Run the backend locally
# This will allow you to test the Amazon API Gateway Rest API and AWS Lambda
# functions locally. However, if you are using other resources (e.g. Amazon
# DynamoDB table, Amazon S3 bucket), you should deploy them to AWS first.
make --directory backend local

Hints

License Summary

This sample code is made available under the MIT-0 license. See the LICENSE file.