Skip to main content
Version: 1.2

Quick Start ⚡️

This quick start will use the @servable/parse-server-engine engine.

Step 1: Install Node JS

Before you install Servable, make sure to download and install Node.js (version 18.x or higher), a JavaScript runtime. When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Step 2: Docker (for local environment)

  • Docker 👉 Version 20.10.0 or above
  • Docker compose 👉 Version #TODO or above

The easiest and recommended way to get Docker Compose is to install Docker Desktop. Docker Desktop includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites. More

Step 3: Install the Servable CLI

The Servable Command Line Interface

npm install -g @servable/cli

Step 4: Create a new Servable service

Using the @servable/parse-server-engine:

servable app new -q

The Servable service has a dedicated system docker-compose for local development that will start a mongodb database, a Parse Server dashboard, a Redis cache database and a Redis Live Query server.

Step 5: Add your own model

servable model add

Models definition are stored in the app/schema folder.

Step 6: Start the server

npm run start

At this point the local Servable docker compose has been launched and you can access