TanStack Query with Orbit.js

A library for using TanStack Query with Orbit.js.

Using the library

You can use the library through the packages:

• @tanstack-query-with-orbitjs/core
• @tanstack-query-with-orbitjs/react

Examples

• Chat app with TanStack Query
  Example chat app using ONLY TanStack Query. For more information, see the Results: A concrete example of the problem chapter in my degree thesis.
• Chat app with TanStack Query and Orbit.js
  Modified version of Chat app with TanStack Query which also uses Orbit.js and @tanstack-query-with-orbitjs/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 and the Dev Containers extension and clone the repository in a 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 v16.13 or newer (the newer, the better).

2. Enable Corepack so that the correct package manager is used. If you installed Node.js using Homebrew, you'll need to install Corepack separately:

   brew install corepack

   Else, Corepack is bundled with Node.js, and to enable it, all you need to do is run the command:

   corepack enable

3. Install project dependencies by running the following command in the root of your repo.

   pnpm install