Add README

This commit is contained in:
Andrew Gundersen 2026-07-16 20:15:59 +00:00
commit 0c5dad9849

View file

@ -1,24 +1,22 @@
# README
# crimata-website
This README would normally document whatever steps are necessary to get the
application up and running.
Marketing site and signup flow for Crimata. Rails 7 app handling passwordless (magic-link) login, pricing/checkout via Stripe, and kicking off instance provisioning once a subscription is created.
Things you may want to cover:
## What it does
* Ruby version
- `/` and `/pricing` — marketing pages
- `/login` — passwordless magic-link auth
- `/checkout/start` — creates a Stripe Checkout session for the subscription
- `/checkout/webhook` — on successful payment, calls out to `crimata-infra`'s `/instances` endpoint to provision the customer's instance
* System dependencies
## Running it
* Configuration
Needs Postgres, Stripe API keys, a Resend API key (for magic-link emails), and `INFRA_SERVICE_URL` pointing at a running `crimata-infra` instance.
* Database creation
```
bundle install
bin/rails db:create db:migrate
bin/rails server
```
* Database initialization
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
* Deployment instructions
* ...
Configured for deployment on Fly.io (`fly.toml`), but that hasn't been kept up to date since moving off Fly — expect some setup friction there.