Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tsamaya/aws-lambda-w3w-map-api

extending what3words API with a webmap response using serverless and AWS lambda
https://github.com/tsamaya/aws-lambda-w3w-map-api

aws-lambda continous-integration continuous-delivery nodejs travis-ci

Last synced: 18 days ago
JSON representation

extending what3words API with a webmap response using serverless and AWS lambda

Host: GitHub
URL: https://github.com/tsamaya/aws-lambda-w3w-map-api
Owner: tsamaya
License: mit
Created: 2017-11-19T11:46:04.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2023-04-10T19:17:18.000Z (almost 2 years ago)
Last Synced: 2024-11-11T07:39:23.313Z (3 months ago)
Topics: aws-lambda, continous-integration, continuous-delivery, nodejs, travis-ci
Language: EJS
Homepage:
Size: 331 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # aws-lambda-w3w-map-api

[![Build Status](https://travis-ci.org/tsamaya/aws-lambda-w3w-map-api.svg?branch=master)](https://travis-ci.org/tsamaya/aws-lambda-w3w-map-api)

This repository shows how to extend [what3words API](https://what3words.com) adding a API method returning a webmap.

After the quick start the how-to section describes step by step how to create the same kind of AWS lambda function and how to deploy it via [travis-ci](https://travis-ci.org) build.

## Quick start

### Prerequisites

- node, npm or yarn

- serverless : `$ npm install -g serverless`

- what3words API key : [register](https://accounts.what3words.com/)

### AWS - Credentials

[Watch the video on setting up credentials](https://www.youtube.com/watch?v=KngM5bfpttA)

or look at serverles documentatoon about [credentials](https://serverless.com/framework/docs/providers/aws/guide/credentials/)

Adding a profile on the AWS config

    $ serverless config credentials --provider aws --key  --secret  --profile 

### Clone the repo

	$ git clone https://github.com/tsamaya/aws-lambda-w3w-map-api.git

	$ cd aws-lambda-w3w-map-api

### Setup

	$ npm i

create environment.yml file

    $ serverless env --attribute W3W_API_KEY --value  --stage dev

don't forget for the production environment to add the according stage

    $ serverless env --attribute W3W_API_KEY --value  --stage prod

### Quick test

	$ sls offline start

open your browser with :

- [http://localhost:3000/what3words/map?addr=launch.posts.wedge](http://localhost:3000/what3words/map?addr=launch.posts.wedge) returns a map using [OpenStreetMap](https://www.openstreetmap.org) and [LeafletJS](http://leafletjs.com/)

- [http://localhost:3000/what3words/map?addr=launch.posts.wedge&type=esri](http://localhost:3000/what3words/map?addr=launch.posts.wedge&type=esri) returns a map using [esriJS](https://js.arcigs.com) with the `streets` basemap

- [http://localhost:3000/what3words/map?addr=launch.posts.wedge&type=google&googleKey=YOUR-GOOGLE-KEY](http://localhost:3000/what3words/map?addr=launch.posts.wedge&type=google&googleKey=YOUR-GOOGLE-KEY) returns a map using [Google Maps](https://developers.google.com/maps/documentation/javascript/), you need to provide your own Google API key

### Quick deploy

	$ sls [--aws-profile your-aws-profile] deploy

# How to

Create a boilerplate for aws-nodejs

    $ serverless create --template aws-nodejs --path aws-lambda-w3w-map-api

    $ cd aws-lambda-w3w-map-api/

    $ ls -al

will output this directory strucutre

```

.

├── .gitignore

├── handler.js

└── serverless.yml

```

`handler.js` contains a hello world example.

init `package.json`

    $ npm init -y

install dependencies

	$ npm i -S axios dotenv ejs

install dev-dependencies

	linting package

	    $ npm i -D eslint eslint-config-airbnb-base eslint-plugin-import

	serverless helpers

	    $ npm i -D serverless-env-generator serverless-offline

edit serverless.yml file

```yaml

plugins:

  - serverless-env-generator

  - serverless-offline

# Plugin config goes into custom:

custom:

  envFiles: #YAML files used to create .env file

    - environment.yml

```

create the travis file

```yaml

language: node_js

node_js:

- '6.10'

env:

  global:

    - SLS_DEBUG=true

before_install:

  - npm i -g serverless

install:

  - npm i

  - serverless env --attribute W3W_API_KEY --value $W3W_API_KEY --stage dev

  - serverless env --attribute W3W_API_KEY --value $W3W_API_KEY --stage prod

after_script: ./deploy.sh

```

Update travis-ci repository settings, and create private environment variables:

- AWS_ACCESS_KEY_ID

- AWS_SECRET_ACCESS_KEY

- W3W_API_KEY

create the deploy script:

```bash

#!/usr/bin/env bash

set -e

BRANCH=${TRAVIS_BRANCH:-$(git rev-parse --abbrev-ref HEAD)}

if [[ $BRANCH == 'master' ]]; then

  STAGE="prod"

elif [[ $BRANCH == 'develop' ]]; then

  STAGE="dev"

fi

if [ -z ${STAGE+x} ]; then

  echo "Not deploying changes";

  exit 0;

fi

echo "Deploying from branch $BRANCH to stage $STAGE"

sls deploy --stage $STAGE

```

enjoy :smile:

## Resources

- [serverless](https://serverless.com)

## Licensing

Licensed under the MIT License

A copy of the license is available in the repository's [LICENSE](LICENSE.md) file.