https://github.com/danielgiljam/tanstack-query-with-orbitjs
TanStack Query with Orbit.js
https://github.com/danielgiljam/tanstack-query-with-orbitjs
docusaurus live-query nextjs nx orbit orbitjs orm plugin query react react-query tanstack-query
Last synced: 29 days ago
JSON representation
TanStack Query with Orbit.js
- Host: GitHub
- URL: https://github.com/danielgiljam/tanstack-query-with-orbitjs
- Owner: DanielGiljam
- License: mit
- Created: 2023-02-05T20:00:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T09:13:39.000Z (about 1 month ago)
- Last Synced: 2025-04-05T16:18:59.145Z (about 1 month ago)
- Topics: docusaurus, live-query, nextjs, nx, orbit, orbitjs, orm, plugin, query, react, react-query, tanstack-query
- Language: TypeScript
- Homepage: https://danielgiljam.com/degree-thesis
- Size: 3.36 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TanStack Query with Orbit.js
A library for using [TanStack Query](https://tanstack.com/query) with [Orbit.js](https://orbitjs.com/).
## Using the library
You can use the library through the packages:
- [`@tanstack-query-with-orbitjs/core`](libs/core)
- [`@tanstack-query-with-orbitjs/react`](libs/react)
## Examples
- [**Chat app with TanStack Query**](apps/example-chat-app-with-tanstack-query)
Example chat app using _ONLY_ TanStack Query. For more information, see the [_Results: A concrete example of the problem_](https://danielgiljam.com/degree-thesis/results#a-concrete-example-of-the-problem) chapter in my degree thesis.
- [**Chat app with TanStack Query and Orbit.js**](apps/example-chat-app-with-tanstack-query-and-orbitjs)
Modified version of [Chat app with TanStack Query](apps/example-chat-app-with-tanstack-query) which also uses Orbit.js and [`@tanstack-query-with-orbitjs/core`](libs/core).
## Development environment
You need to set up a development environment in order to:
- Develop / contribute to the library
- Run the examples
### Configuring the development environment the recommended way
The recommended way to set up the development environment is to use [VSCode](https://code.visualstudio.com/) and the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension and [clone the repository in a container volume](https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume). This way everything is set up for you automatically.
If you don't want to use VSCode and the Dev Containers extension, read on about configuring the development environment.
### Configuring the development environment manually
1. Install [Node.js](https://nodejs.org/en) v16.13 or newer (the newer, the better).
2. Enable [Corepack](https://nodejs.org/api/corepack.html) so that the correct package manager is used.
If you installed Node.js using Homebrew, you'll need to install Corepack separately:
```sh
brew install corepack
```
Else, Corepack is bundled with Node.js, and to enable it, all you need to do is run the command:
```sh
corepack enable
```
3. Install project dependencies by running the following command in the root of your repo.
```sh
pnpm install
```