Skip to content

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.

Main Package (Required)

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

bash
npm install sidequest
bash
yarn add sidequest
bash
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:

bash
npm install @sidequest/postgres-backend
bash
yarn add @sidequest/postgres-backend
bash
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:

bash
npm install @sidequest/sqlite-backend
bash
yarn add @sidequest/sqlite-backend
bash
pnpm add @sidequest/sqlite-backend

MySQL

For MySQL, you can install the backend driver with:

bash
npm install @sidequest/mysql-backend
bash
yarn add @sidequest/mysql-backend
bash
pnpm add @sidequest/mysql-backend

MongoDB

For MongoDB, you can install the backend driver with:

bash
npm install @sidequest/mongo-backend
bash
yarn add @sidequest/mongo-backend
bash
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:

bash
npm install -g @sidequest/cli
bash
yarn global add @sidequest/cli
bash
pnpm add -g @sidequest/cli

Released under the LGPL-3.0 License.