Skip to content
This repository was archived by the owner on Sep 19, 2024. It is now read-only.

Commit 0aa79e3

Browse files
committedSep 27, 2022
Merge branch 'main' into chore/update_buildroot_version
2 parents 1ea5fda + 83307ac commit 0aa79e3

File tree

1,196 files changed

+20440
-34
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,196 files changed

+20440
-34
lines changed
 

‎README.md

+26-16
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
1-
# :elephant: PostgreSQL, in your browser :globe_with_meridians:
2-
3-
`postgres-browser` uses WASM to run a full Postgres database inside the browser.
4-
5-
## :zap: Getting started
6-
7-
```bash
8-
cd packages/pg-browser && npx serve
1+
<div align="center">
2+
<h1 align="center">Postgres WASM</h1>
3+
<p align="center">A PostgresQL server instance running in a virtual machine running in the browser<br />
4+
<i>by Supabase &amp; Snaplet</i></p>
5+
<img align="center" src="https://user-images.githubusercontent.com/44849/192262287-29d1ecb2-8ff7-40cb-bd1f-68d707493a86.png" alt="Snaplet, Supabase and friends" width="480">
6+
<br /><br />
7+
<a href="https://postgres-wasm.netlify.com">Demo</a>
8+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
9+
<a href="https://app.snaplet.dev/chat">Discord</a>
10+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
11+
<a href="https://www.snaplet.dev/">Snaplet</a>
12+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
13+
<a href="https://www.supabase.com">Supabase</a>
14+
</div>
15+
<br />
16+
17+
## Quickstart
18+
19+
```terminal
20+
cd packages/runtime && npx serve
921
```
1022

1123
Go to http://localhost:3000 and have fun!
1224

13-
## :brain: Architecture
14-
15-
> TODO
25+
## Packages
1626

17-
## :eyes: Going further
27+
This repo is split into three packages that build up the environment for running PostgresQL in the browser.
1828

19-
- [pg-browser](/packages/pg-browser)
20-
- [Buildroot](/packages/buildroot)
21-
- [Websockproxy](/packages/websockproxy)
29+
- [runtime](/packages/runtime): The v86 emulator that starts the `buildroot` image
30+
- [Buildroot](/packages/buildroot): Scripts to build the CPU and memory snapshot run by v86.
31+
- [Websockproxy](/packages/websockproxy): Networking
2232

23-
## :clap: Acknowledgements
33+
## Acknowledgements
2434

2535
- [v86](https://github.com/copy/v86) which is **the** emulator for running x86 operating systems in the browser, without it none of the following projects would be possible
2636
- [crunchydata playground](https://www.crunchydata.com/developers/playground) for leading the way and showing the world that it was possible to run PostgreSQL in the browser

‎packages/buildroot/legal-info/host-licenses/acl-2.3.1/doc/COPYING

+347
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)