Documentation

Installation

Get started with Qortex

Install qortex using your preferred package manager and set up your project.

Choose Your Package

Install qortex-core OR qortex-react - not both! qortex-react includes all core APIs.

Install qortex using your preferred package manager. Choose the package that fits your needs:

For React Projects

If you're using React, install qortex-react (includes all core APIs):

For React Projects

# npm
npm install qortex-react


# yarn
yarn add qortex-react


# pnpm
pnpm add qortex-react

For Non-React Projects

If you're using vanilla JS, Vue, or other frameworks, install qortex-core:

For Non-React Projects

# npm
npm install qortex-core


# yarn
yarn add qortex-core


# pnpm
pnpm add qortex-core

Import Examples

How to import from each package:

Import Examples

// React users - everything from qortex-react
import { useQuery, useQueryData, registerFetcher, fetchQuery } from 'qortex-react';


// Core-only users - core APIs from qortex-core
import { registerFetcher, fetchQuery } from 'qortex-core';


// Persister (subpackage) - for both React and core users
import { createPersister } from 'qortex-core/persister'; // or 'qortex-react/persister'

Related Pages

quick-startuseQuery