Stores & serves geospatial data using AWS DynamoDB and AWS Lambda. This is a hobby project I'm using to revisit a few, mostly unrelated, ideas; z-order indexed data in DynamoDB, Lambda function URLs, a middleware-less & minimal dependency node.js server, Typescript type checking & vanilla Javascript, and web components too. I'm having to implement auth as well because the AWS options for Lambda URIs are limited.
GET /domains - List domains
GET /d/<domain-id> - Get a domain
PUT /d/<domain-id> - Create a domain
PATCH /d/<domain-id> - Update a domain
GET /d/<domain-id>/items - Returns all features
POST /d/<domain-id>/item - Create a new feature
GET /d/<domain-id>/item/<item-uuid> - Get a single feature
PATCH /d/<domain-id>/item/<item-uuid> - Update a single feature
DELETE /d/<domain-id>/item/<item-uuid> - Delete a single feature
GET /d/<domain-id>/query?bbox=<minx>,<miny>,<maxx>,<maxy> - Query for features in a bounding box
GET /d/<domain-id>/query?point=<x>,<y> - Query for features near a point
GET /account - Get info about logged in user.
POST /account - Create an account
PATCH /account/<account-id> - Update an account
POST /authorize - Should probably change this to /login
GET /logout
| Environment variable | Description | Example |
|---|---|---|
| DYNAMODB_TABLE_NAME | DynamoDB table name | my-table |
| DYNAMODB_ENDPOINT | Overrides the default DynamoDB endpoint, useful for local testing | http://localhost:8000 |
| JWT_SECRET | Hex encoded HS256 secret. | |
| APP_URI | Base URI for the web application | http://localhost:8080 |
export STACK_NAME=morton-test
aws cloudformation deploy --template-file ./cloudformation/template.json --stack-name $STACK_NAME --no-execute-changeset --capabilities CAPABILITY_IAM
# Note: on first deploy you'll need to `--parameter-overrides JWTSecret=...`
export STACK_NAME=morton-test
export FUNCTION_ARN=$(aws cloudformation describe-stacks --stack-name $STACK_NAME --query 'Stacks[0].Outputs[?OutputKey==`LambdaHandlerArn`].OutputValue' --output text)
cd dist && zip bundle.zip index.js
aws lambda update-function-code --function-name $FUNCTION_ARN --zip-file fileb://dist/bundle.zip
export STACK_NAME=morton-test
export WEBSITE_BUCKET=$(aws cloudformation describe-stacks --stack-name $STACK_NAME --query 'Stacks[0].Outputs[?OutputKey==`WebsiteBucket`].OutputValue' --output text)
bundler exec jekyll build
aws s3 sync ./web/_site/ s3://${WEBSITE_BUCKET}/ --delete
| Partition | Sort | IndexedDomain | Morton |
|---|---|---|---|
| item: | n/a | n/a | |
| : | : | ||
| _accounts | n/a | n/a | |
| _domains | n/a | n/a |
Indexed domain is a secondary partition with a Mortan as a numeric sort key. TODO These should have more generic names.
Related reading
- https://aws.amazon.com/blogs/database/z-order-indexing-for-multifaceted-queries-in-amazon-dynamodb-part-1/
- https://docs.mapbox.com/help/glossary/zoom-level/
https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
Test suite assumes you've got Docker available so that it can run "DynamoDB Local". It will also attempt to use port 8000 for the same. Currently tests also assume that DynamodDB local is also running. See notes below...
Quickest way to get running locally, run tests and then start the local server in test mode;
npm test
IS_TEST_RUN=true node ./scripts/local.js
The front end can be started using jekyll.
cd web
bundler exec jekyll serve
A proxy exists in the local server sot that that API and Static resouces can all be accessed at localhost:8080
If you're on newer, non-intel, Mac you may want to use lima to manage a VM for Docker. After installing w/ brew that looks something like:
limactl start template://docker
docker context create lima-docker --docker "host=unix:///Users/<myusername>/.lima/docker/sock/docker.sock"
docker context use lima-docker
docker run -d --rm -p 8000:8000 amazon/dynamodb-local:latest \
-jar DynamoDBLocal.jar \
-disableTelemetry \
-inMemory \
-sharedDb
aws --endpoint-url http://localhost:8000 dynamodb scan --table-name test
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent