Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

README.md

144 lines6.2 KB

1<div align="center">
2 <picture>
3 <source
4 media="(prefers-color-scheme: dark)"
5 srcset="https://tanstack.com/api/readme/db.png?theme=dark"
6 />
7 <source
8 media="(prefers-color-scheme: light)"
9 srcset="https://tanstack.com/api/readme/db.png"
10 />
11 <img
12 src="https://tanstack.com/api/readme/db.png"
13 alt="TanStack DB"
14 width="900"
15 />
16 </picture>
17</div>
18​
19<br />
20​
21<div align="center">
22 <a href="https://npmjs.com/package/@tanstack/db" target="\_parent">
23 <img alt="" src="https://img.shields.io/npm/dm/@tanstack/db.svg" alt="npm downloads" />
24 </a>
25 <a href="https://github.com/TanStack/db" target="\_parent">
26 <img alt="" src="https://img.shields.io/github/stars/TanStack/db.svg?style=social&label=Star" alt="GitHub stars" />
27 </a>
28 <a href="https://bundlejs.com/?q=%40tanstack%2Fdb&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge=" target="\_parent">
29 <img alt="" src="https://deno.bundlejs.com/?q=@tanstack/db&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" alt="Bundle size" />
30 </a>
31</div>
32​
33<div align="center">
34 <a href="#status">
35 <img src="https://img.shields.io/badge/status-beta-yellow" alt="Status - BETA">
36 </a>
37 <a href="https://bestofjs.org/projects/tanstack-db">
38 <img alt="Best of JS" src="https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=TanStack%2Fdb%26since=daily" alt="Best of JS"/>
39 </a>
40 <a href="https://twitter.com/tan_stack">
41 <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
42 </a>
43</div>
44​
45<div align="center">
47### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
48</div>
49​
50# TanStack DB
51​
52> Tanstack DB is currently in BETA. See [the release post](https://tanstack.com/blog/tanstack-db-0.1-the-embedded-client-database-for-tanstack-query) for more details.
53​
54The reactive client store for your API.
55​
56TanStack DB solves the problems of building fast, modern apps, helping you:
57​
58- Avoid endpoint sprawl and network waterfalls by loading data into normalized collections
59- Optimise client performance with sub-millisecond live queries and real-time reactivity
60- Take the network off the interaction path with instant optimistic writes
61​
62Data loading is optimized. Interactions feel instantaneous. Your backend stays simple and your app stays blazing fast. No matter how much data you load.
63​
64<a href="https://tanstack.com/db" style="font-weight:bold" >Read the docs →</a>
65<br />
66​
67## Get Involved
68​
69- We welcome issues and pull requests!
70- Participate in [GitHub discussions](https://github.com/TanStack/db/discussions)
71- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
72- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
73​
74## Partners
75​
76<table align="center">
77<tr>
78<td>
79<a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
80<picture>
81 <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-D643Zkrv.svg" height="40" />
82 <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-CIzGLYU_.svg" height="40" />
83 <img src="https://tanstack.com/assets/coderabbit-light-CIzGLYU_.svg" height="40" alt="CodeRabbit" />
84</picture>
85</a>
86</td>
87<td>
88<a href="https://www.cloudflare.com?utm_source=tanstack">
89<picture>
90 <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-Co-Tyjbl.svg" height="60" />
91 <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-6Ojsn8yh.svg" height="60" />
92 <img src="https://tanstack.com/assets/cloudflare-black-6Ojsn8yh.svg" height="60" alt="Cloudflare" />
93</picture>
94</a>
95</td>
96</tr>
97<tr>
98<td>
99<a href="https://electric-sql.com">
100<picture>
101 <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/electric-dark-Bfu2Vl2j.svg" height="60">
102 <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/electric-light-C-5MDda4.svg" height="60">
103 <img src="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo.with-background.sm.png" height="60" alt="ElectricSQL logo"/>
104</picture>
105</a>
106</td>
107<td>
108<a href="https://www.prisma.io?utm_source=tanstack&via=tanstack">
109<picture>
110 <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/prisma-dark-DwgDxLwn.svg" height="60">
111 <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/prisma-light-Cloa3Onm.svg" height="60">
112 <img src="https://tanstack.com/assets/prisma-dark-DwgDxLwn.svg" height="60" alt="Prisma"/>
113</picture>
114</a>
115</td>
116</tr>
117</table>
118​
119<div align="center">
120<img src="./media/partner_logo.svg" alt="DB & you?" height="65">
121<p>
122We're looking for TanStack DB Partners to join our mission! Partner with us to push the boundaries of TanStack DB and build amazing things together.
123</p>
124<a href="mailto:partners@tanstack.com?subject=TanStack DB Partnership"><b>LET'S CHAT</b></a>
125</div>
126​
127## Explore the TanStack Ecosystem
128​
129- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
130- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
131- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
132- <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching <br/>
133- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
134- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
135- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
136- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
137- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
138- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
139- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
140​
141… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>
142v>
143​
144<!-- Use the force, Luke -->