@tendrelhq/graphql

Development requires bun. For best results, run locally with docker.

1. cp .envrc.template .envrc and fill in the blanks.
2. cp .env.local.template .env.local and fill in the blanks.
3. for development, run bun install
4. to run locally, run just start¹ (docker compose up)

If you have nix installed (which I highly recommend you do) you can use the dev environment via devenv up. This will start:

1. postgresql at [localhost:5432]
2. pgadmin at [localhost:5050]

The first time you do this will require syncdbing; I will fix this eventually.

Lastly, there are a bunch of sql scripts in ./sql. I plan on manually keeping these things up to date in the production database. In development I've been using sqitch as a helpful little migration tool. Once installed, basically the only command you need is sqitch rebase -y. This will revert (if applicable) and deploy the scripts in ./sql as per ./sql/sqitch.plan.

formatting

If you don't have nix and want to format, the generated configuration looks like this:

[formatter.alejandra]
command = "alejandra"
excludes = []
includes = ["*.nix"]
options = []

[formatter.biome]
command = "biome"
excludes = []
includes = ["*.graphql", "*.json", "*.md", "*.ts"]
options = ["check", "--write"]

[formatter.prettier]
command = "prettier"
excludes = []
includes = ["*.yaml", "*.yml"]
options = ["--write"]

[formatter.shfmt]
command = "shfmt"
excludes = []
includes = ["*.sh", "*.bash", "*.envrc", "*.envrc.*"]
options = ["-s", "-w", "-i", "2"]

You can derive the correct commands from there, e.g.

$ biome check --write **/*.{graphql,json,ts}
Checked 198 files in 107ms. No fixes applied.

$ prettier --write **/*.{yaml,yml}
copilot/environments/beta/manifest.yml 16ms (unchanged)
copilot/environments/dev/manifest.yml 2ms (unchanged)
copilot/environments/test/manifest.yml 2ms (unchanged)
copilot/graphql/manifest.yml 6ms (unchanged)
copilot/pipelines/graphql-workloads/buildspec.yml 4ms (unchanged)
copilot/pipelines/graphql-workloads/manifest.yml 1ms (unchanged)

Footnotes

1. If you don't have just installed, you can either install it or run the underlying command directly by looking at ./justfile ↩