JoseRamonMartinez/pokedex-alexa-aws

Serverless app with alexa skill frontend

POKEDEX

Serverless backend with NoSQL Database and APIs endpoints.
Alexa Frontend

Table of Contents

1. About The Project
2. Built With
3. API Usage
4. Getting Started
   • Prerequisites
   • Installation
5. Author
6. License

1. About The Project 📢

The project consist of a DynamoDB database with pokemons information and 3 endpoints with lambdas. The frontend cosist of a Alexa Skill that use the API serverless provided. The system follows the IaaC patters.

(back to top)

2. Built With 🛠️

Serverless Framework: Framework to implement IaaC with cloud providers. AWS Services:

• Lambda: Serverless logic functions
• DynamoDB: NoSQL database
• API Gateway: API Rest management
• CloudWatch event: Schedule the system trigger.
• XRAY: Analize and debug distributed apps

GOOD PRACTICES APPLIED

• Secondary Index created in the pokmeons table to reduce DynamoDB cost of get to O(1)

(back to top)

3. API 🚀

HTTP	Route	Description
GET	/prod/pokemons/id/{name}	Get pokemon info by id
GET	/prod/pokemons/name/{name}	Get pokemon by name
POST	prod/pokemons/post	Save a pokemon in the database

To test the endpoints, you can download the Postman Collection.
Environment needed:

• endpoint: aws url
• api-key: key generated to access the endpoints

4. Getting Started 🔧

This is an example of how you may give instructions on setting up your project and deploy to AWS cloud.

4.1 Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• serverless

  npm install serverless@latest -g

4.2 Installation 🛠️

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Install NPM packages

   npm install

3. Create a config.yml

    pokemonsTableName: <CustomName>
    pokemonsSeeder: [./seeds/<CustomName.json>]
    apiUrls:
      pokemons: <CustomName>
    accountIdNumber: <AWS_ACCOUNT_ID_NUMBER>

4. Deploy to AWS

   sls deploy --aws-profile <profile>

5. Insert the seed into the DB

   sls dynamodb:seed --aws-profile <profile>

5. Author ✒️

José Ramón Martínez Riveiro

6. License 📄

Copyright © 2017, José Ramón Martínez Riveiro.

(back to top)