Skip to content

Commit 8916b7a

Browse files
authored
chore: update root readme
1 parent bb66b1c commit 8916b7a

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
1-
# postgres-new
1+
# postgres.new
22

33
In-browser Postgres sandbox with AI assistance.
44

5+
![github-repo-hero](https://github.com/user-attachments/assets/e55f7c0d-a817-4aeb-838e-728aabda3a5d)
6+
7+
With [postgres.new](https://postgres.new), you can instantly spin up an unlimited number of Postgres databases that run directly in your browser (and soon, deploy them to S3).
8+
9+
Each database is paired with a large language model (LLM) which opens the door to some interesting use cases:
10+
11+
- Drag-and-drop CSV import (generate table on the fly)
12+
- Generate and export reports
13+
- Generate charts
14+
- Build database diagrams
15+
16+
## How it works
17+
All queries in postgres.new run directly in your browser. There’s no remote Postgres container or WebSocket proxy.
18+
19+
How is this possible? [PGlite](https://pglite.dev/), a WASM version of Postgres that can run directly in your browser. Every database that you create spins up a new instance of PGlite that exposes a fully-functional Postgres database. Data is stored in IndexedDB so that changes persist after refresh.
20+
521
## Monorepo
622

723
This is a monorepo split into the following projects:
824

9-
- [Frontend (Next.js)](./apps/postgres-new/)
10-
- [Backend (pg-gateway)](./apps/db-service/)
25+
- [Frontend (Next.js)](./apps/postgres-new/): This contains the primary web app built with Next.js
26+
- [Backend (pg-gateway)](./apps/db-service/): This serves S3-backed PGlite databases over the PG wire protocol using [pg-gateway](https://github.com/supabase-community/pg-gateway)
27+
28+
## Video
29+
30+
[![image](https://github.com/user-attachments/assets/9da04785-d813-4e9c-a400-4e00c63381a1)](https://youtu.be/ooWaPVvljlU)
1131

1232
## License
1333

0 commit comments

Comments
 (0)