Add README

This commit is contained in:
Andrew Gundersen 2026-07-16 20:16:00 +00:00
commit 63a9d67a9d

24
README.md Normal file
View file

@ -0,0 +1,24 @@
# crimata-infra
Backend service that provisions and manages actual customer infrastructure for Crimata: spins up an EC2 instance, points DNS at it (Route 53), sends the customer a notification (via Resend), and can export their data to S3.
## What it does
Exposes a small HTTP API (Go, [chi](https://github.com/go-chi/chi) router):
- `POST /instances` — provision a new customer instance (called by `crimata-website`'s Stripe webhook)
- `GET /instances/:slug` — look up an instance
- `DELETE /instances/:slug` — tear one down
`provision.sh` is the bootstrap script that actually runs on the new EC2 instance — currently just installs nginx and a placeholder welcome page, a work in progress.
## Running it
Needs Postgres, an AWS account (EC2 + Route53 + S3 permissions), and a Resend API key.
```
cp .env.example .env # fill in DATABASE_URL, AWS credentials, EC2/DNS/S3 config
go run ./cmd/server
```
There's also a `terraform/` directory for provisioning the supporting AWS resources (VPC, security groups, etc.) this service depends on.