Installation Instructions

To get started with Sidequest.js, you need to install the main package along with the backend driver of your choice. Below are the installation instructions for different package managers.

WARNING

Make sure you are using Node.js >= 22.6.0. Also, Sidequest does not run with Bun.

Main Package (Required)

To get started with Sidequest, first install the main package:

npm

npm install sidequest

yarn

yarn add sidequest

pnpm

pnpm add sidequest

Backend Drivers (Required)

To keep the application minimal, the main package does not include the backend drivers. Thus you need to install only the driver you will use.

PostgreSQL

We recommend using PostgreSQL for production applications. Install the PostgreSQL backend driver with:

npm

npm install @sidequest/postgres-backend

yarn

yarn add @sidequest/postgres-backend

pnpm

pnpm add @sidequest/postgres-backend

SQLite

SQLite is the default backend and is suitable for development or small applications. However, it is not recommended for production use. To install the SQLite backend driver, run:

npm

npm install @sidequest/sqlite-backend

yarn

yarn add @sidequest/sqlite-backend

pnpm

pnpm add @sidequest/sqlite-backend

MySQL

For MySQL, you can install the backend driver with:

npm

npm install @sidequest/mysql-backend

yarn

yarn add @sidequest/mysql-backend

pnpm

pnpm add @sidequest/mysql-backend

MongoDB

For MongoDB, you can install the backend driver with:

npm

npm install @sidequest/mongo-backend

yarn

yarn add @sidequest/mongo-backend

pnpm

pnpm add @sidequest/mongo-backend

CLI Tool (Optional)

We also provide a CLI Tool to manage backend migrations and configurations. Sidequest will try to manage it in runtime, but if you prefer to do it via CLI for better control, you can install it globally:

npm

npm install -g @sidequest/cli

yarn

yarn global add @sidequest/cli

pnpm

pnpm add -g @sidequest/cli