Getting Started

Installation

How to Install Joystick on your computer.

Install Node.js + NPM

In order to install Joystick, you'll need to have Node.js (v20+) and NPM installed on your computer. You can download an installer for both for your operating system from the official Node.js downloads page. Alternatively, you can use a tool like Node Version Manager (NVM) to install and switch bettwen multiple versions of Node.js and NPM.

Installing Joystick via NPM

Once you have Node.js and NPM installed, open up your terminal and run the following command:

Terminal

npm i -g @joystick.js/cli

That's it! You're ready to create your first app and start using Joystick.

Database Support

Prior to Joystick 1.0.0-rc2, any databases used by your app were required to be installed on your computer, independent of Joystick. As of the 1.0.0-rc2 release, Joystick will automatically download and install a binary for your app's chosen database(s) (determined by your settings.env.json file) when you start your app for the first time.