event-guru-backend's Introduction

Event Guru Backend

Get upcoming concerts for a location of your choice with a bunch of additional data.

API documentation can be found here: https://documenter.getpostman.com/view/4279998/RWaC1rD5

How to run

Prerequisites:

make sure you are logged in with your aws cli
create a src/config/config-prod.json file (or -dev, depending on the stage) and make sure following variables are set (can also be set as environment variable):

{
    "SONGKICK_API_KEY": "YOUR_SONGKICK_API_KEY",
    "BITLY_ACCESS_TOKEN": "YOUR_BITLY_ACCESS_TOKEN",
    "SLS_APP": "SERVERLESS PLATFORM APP",
    "SLS_TENANT": "SERVERLESS PLATFORM TENANT"
}

Also make sure that AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are set as environment variable.

Architectural decisions are tracked in ARCHITECTURAL_DECISIONS.md.

Test

To test the app run

npm test

Deploy

To deploy the app run

npm run deploy

// do to an suboptimal webpack configuration we have to deploy the artists function separately
npm run deploy:artists

Make sure to have a proper config file for every stage, like mentioned in the "Prerequisites" section.

Enable the TTL feature in the DynamoDB tables manually in the AWS console for the events cache table. The TTL attribute is ttl.

You cannot deploy from a windows machine, as the execution permissions for linux cannot be copied!

next lines are outdated!

Mail with AWS SES

You have to react to bounce and complaint messages. We do this via SNS which is connected to SES. SNS sends the notification to lambda.

Setup a domain on SES
Go to you domain's SES settings and setup Notifications. Use the sns notifications that are build by serverless
Handle bounce and complaint notifications within aws-ses-notifications

event-guru-backend's People

Contributors

Watchers

event-guru-backend's Issues

Request spotify webapi with access token

The current used endpoits don't require and access token until May 29. so we have to use one.

https://developer.spotify.com/news-stories/2017/01/27/removing-unauthenticated-calls-to-the-web-api/

Use date-fns instead of moment

https://date-fns.org/

Send daily click and ses stats per mail

Fetch the most popular locations every night

The make the skill as fast as possible we should get all events by the most popular cities every night so that even the first user gets a fast and cached response.

10 most popular cities in Germany:
Berlin
Hamburg
München
Cologne
Frankfurt
Essen
Dortmund
Stuttgart
Düsseldorf
Bremen

10 most popular cities in USA:
New York
Los Angeles
Chicago
Houston
Philadelphia
Phoenix
San Antonio
San Diego
Dallas
San Jose
San Francisco

10 most popular cities in England:
London
Birmingham
Leeds
Glasgow
Sheffield
Bradford
Liverpool
Edinburgh
Manchester
Bristol

We should not forget that if the user searches the same city but uses another name of it (like 'München' and 'Munich') we request another time because the names of the city get saved directly. So we have to search for aliases and translations of those cities and cache them as well.

Catch errors from api requests and log them correctly

Errors are currently not all catched so the user will you receive an error with the server. We should catch all possible errors and respond properly to the user.