Starting an App

Once you've created your project, cd into its folder on your computer and run:

joystick start

First, Joystick will check your project's settings.development.json file to see what (if any) databases it has configured. If any of those databases do not have their binary installed on your machine, Joystick will download it for you.

Once all databases are installed, Joystick will start up your app's server on port 2600. Once your app is running, Joystick will notify you in tour terminal with "App running at: http://localhost:2600."

Starting your app on a different port

If you're running multiple Joystick apps on your computer (or other projects), you can optionally change the port you start your Joystick app on by including the --port or -p flag in your start command:

joystick start -p <port-number>

This will make your app accessible in the browser at http://localhost:<port-number>.

Starting a Canary app

If you created your app using one of Joystick's canary releases, it's recommended that you start your app with joystick-canary start instead. This will ensure that you use the version of the Joystick CLI (@joystick.js/cli-canary) that's compatible with the canary packages installed in your app.