The code behind XT play, a web tool for exploring the XTDB database.
It is deployed on an AWS Lambda but can be run locally as a normal web server for ease of development.
This repo is setup to deploy on push to main, so just merge your PR and go!
For the front end you'll need to install deps:
yarn installAfter that for development you'll need two processes:
This can be started with:
npx shadow-cljs watch appNow shadow-cljs will be watching for changes recompiling. See the shadow-cljs docs for more.
Just start your repl in the ordinary way (or be sneaky like me and use the repl from shadow-cljs (not recommended)).
Then you can start the server by running (go) in the user namespace.
You should than be able to browse a dev build at http://localhost:8000.
Infrastructure is spread across five(!) files, all in the cloudformation folder:
| File | Description |
|---|---|
00-github-keys.yml |
Contains the user used by github to deploy |
01-certificate.yml |
Creates the certificate used by CloudFront (must be deployed in us-east-1) |
02-lambda-deps.yml |
Contains the things the lambda needs to deploy (an s3 bucket and role |
03-lambda.yml |
The lambda itself, in a separate file so github can deploy just that |
04-domain.yml |
The stuff needed to address the lambda via a static url |
These are glued together by liberal use of ssm parameters and dynamic references.
On initial deployment they must be deployed in the below order.
Initial creation
[!NOTE] Wait for each step to finish deploying before deploying the next stage
aws cloudformation create-stack \
--capabilities CAPABILITY_IAM \
--stack-name xt-play--github \
--template-body "file://$(pwd)/cloudformation/00-github-keys.yml"Make sure to add the access_key_id and secret_access_key to the github actions secrets.
aws cloudformation create-stack \
--region us-east-1 \
--capabilities CAPABILITY_IAM \
--stack-name xt-play--certificate \
--template-body "file://$(pwd)/cloudformation/01-certificate.yml" \
--parameters ParameterKey=HostedZoneId,ParameterValue=<hostedZoneId> \
ParameterKey=HostedZoneName,ParameterValue=<hostedZoneName>aws cloudformation create-stack \
--capabilities CAPABILITY_IAM \
--stack-name xt-play--lambda-deps \
--template-body "file://$(pwd)/cloudformation/02-lambda-deps.yml"Before running this next step, upload the code to the freshly created s3 bucket.
Look in 03-lambda.yml for the location.
(Updates to this will mainly be done by github)
aws cloudformation create-stack \
--capabilities CAPABILITY_IAM CAPABILITY_AUTO_EXPAND \
--stack-name xt-play--lambda \
--template-body "file://$(pwd)/cloudformation/03-lambda.yml" \
--parameters ParameterKey=PlayCodeVersion,ParameterValue=<versionId>The certificateArn here is from 01-certificate.yml, it can't be an ssm parameter due to being in a different region :/
aws cloudformation create-stack \
--capabilities CAPABILITY_IAM \
--stack-name xt-play--domain \
--template-body "file://$(pwd)/cloudformation/04-domain.yml" \
--parameters ParameterKey=HostedZoneId,ParameterValue=<hostedZoneId> \
ParameterKey=HostedZoneName,ParameterValue=<hostedZoneName> \
ParameterKey=CertificateArn,ParameterValue=<certificateArn>[!NOTE] To run an update just swap out
create-stackforupdate-stackTo delete a stack either use the AWS Console or run:
aws cloudformation delete-stack --stack-name <stack-name>