Skip to content

Commit 4905e83

Browse files
committed
readme
1 parent 9cac329 commit 4905e83

File tree

2 files changed

+17
-63
lines changed

2 files changed

+17
-63
lines changed

README.md

Lines changed: 17 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Supabase Test
1+
# Supabase Test Suite
22

33
<p align="center" width="100%">
44
<img height="250" src="https://raw.githubusercontent.com/launchql/supabase-test/refs/heads/main/docs/img/logos.svg" />
@@ -31,12 +31,6 @@ npx supabase start
3131
# install deps and run all package tests
3232
pnpm install
3333

34-
# if your env needs explicit pg vars, export these:
35-
export PGPORT=54322
36-
export PGHOST=localhost
37-
export PGUSER=postgres
38-
export PGPASSWORD=postgres
39-
4034
# run every package’s tests
4135
pnpm test
4236
```
@@ -45,12 +39,12 @@ pnpm test
4539

4640
this section will walk through everything slowly, from installing tools to running focused tests and exploring the schemas.
4741

48-
- [ ] step 1: install prerequisites (node, pnpm, supabase cli)
49-
- [ ] step 2: initialize supabase and confirm services are healthy
50-
- [ ] step 3: configure pg env vars if your shell needs them
51-
- [ ] step 4: run migrations or package deploys as needed
52-
- [ ] step 5: run tests (full suite and targeted)
53-
- [ ] step 6: inspect policies and iterate
42+
1. install prerequisites (node, pnpm, supabase cli)
43+
2. initialize supabase and confirm services are healthy
44+
3. configure pg env vars if your shell needs them
45+
4. run migrations or package deploys as needed
46+
5. run tests (full suite and targeted)
47+
6. inspect policies and iterate
5448

5549
for the expanded guide with screenshots and copy‑paste commands, see `docs/img/USAGE.md` (coming soon).
5650

@@ -76,51 +70,23 @@ pnpm test
7670

7771
## troubleshooting
7872

73+
- if your environment needs explicit pg variables, export and retry:
74+
75+
```bash
76+
export PGPORT=54322
77+
export PGHOST=localhost
78+
export PGUSER=postgres
79+
export PGPASSWORD=postgres
80+
```
81+
7982
- if `pnpm test` can’t reach postgres, confirm supabase services are running and the `PG*` env vars match the port printed by `npx supabase start`
8083
- if ports are busy, stop old containers or pass a different port to supabase
8184
- node version mismatches can cause odd errors; use node 20+
8285

83-
84-
85-
8686
## Related LaunchQL Tooling
8787

88-
### 🧪 Testing
89-
9088
* [launchql/pgsql-test](https://github.com/launchql/launchql/tree/main/packages/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
91-
* [launchql/graphile-test](https://github.com/launchql/launchql/tree/main/packages/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
92-
* [launchql/pg-query-context](https://github.com/launchql/launchql/tree/main/packages/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
93-
94-
### 🧠 Parsing & AST
95-
96-
* [launchql/pgsql-parser](https://github.com/launchql/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
97-
* [launchql/libpg-query-node](https://github.com/launchql/libpg-query-node): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
98-
* [launchql/pg-proto-parser](https://github.com/launchql/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
99-
* [@pgsql/enums](https://github.com/launchql/pgsql-parser/tree/main/packages/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
100-
* [@pgsql/types](https://github.com/launchql/pgsql-parser/tree/main/packages/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
101-
* [@pgsql/utils](https://github.com/launchql/pgsql-parser/tree/main/packages/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
102-
* [launchql/pg-ast](https://github.com/launchql/launchql/tree/main/packages/pg-ast): **🔍 Low-level AST tools** and transformations for Postgres query structures.
103-
104-
### 🚀 API & Dev Tools
105-
106-
* [launchql/server](https://github.com/launchql/launchql/tree/main/packages/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
107-
* [launchql/explorer](https://github.com/launchql/launchql/tree/main/packages/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
108-
109-
### 🔁 Streaming & Uploads
110-
111-
* [launchql/s3-streamer](https://github.com/launchql/launchql/tree/main/packages/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
112-
* [launchql/etag-hash](https://github.com/launchql/launchql/tree/main/packages/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
113-
* [launchql/etag-stream](https://github.com/launchql/launchql/tree/main/packages/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
114-
* [launchql/uuid-hash](https://github.com/launchql/launchql/tree/main/packages/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
115-
* [launchql/uuid-stream](https://github.com/launchql/launchql/tree/main/packages/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
116-
* [launchql/upload-names](https://github.com/launchql/launchql/tree/main/packages/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
117-
118-
### 🧰 CLI & Codegen
119-
120-
* [@launchql/cli](https://github.com/launchql/launchql/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing LaunchQL projects—supports database scaffolding, migrations, seeding, code generation, and automation.
121-
* [launchql/launchql-gen](https://github.com/launchql/launchql/tree/main/packages/launchql-gen): **✨ Auto-generated GraphQL** mutations and queries dynamically built from introspected schema data.
122-
* [@launchql/query-builder](https://github.com/launchql/launchql/tree/main/packages/query-builder): **🏗️ SQL constructor** providing a robust TypeScript-based query builder for dynamic generation of `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and stored procedure calls—supports advanced SQL features like `JOIN`, `GROUP BY`, and schema-qualified queries.
123-
* [@launchql/query](https://github.com/launchql/launchql/tree/main/packages/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
89+
* [launchql/supabase-test](https://github.com/launchql/launchql/tree/main/packages/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
12490

12591
## Disclaimer
12692

pgenv.sh

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)