Installation

In this guide, we will get Bando running locally. You do not need to understand the entire infrastructure to follow these steps.

What we are building

By the end of this guide, we will have four pieces working together:

• Node.js — runs the Bando runtime.
• PostgreSQL — stores the documents.
• Bando — organizes content and makes it available to the application.
• Studio — lets you manage content through the browser.

Prerequisites

You need Node.js 20 or later, PostgreSQL, and an empty Node project.

If you do not have PostgreSQL installed, you can use Docker. Docker is simply a convenient way to run PostgreSQL locally; it is not a conceptual dependency of Bando.

1. 1. Create the project

   First, create a Node project. npm init creates thepackage.json, which will be used to manage the project's dependencies.

   BASH

   Copiar

   1npm init -y

   2npm install bando-cms

   3npx bando init

   The first command creates the project, the second installs Bando, and the third initializes the required configuration.

2. 2. Start PostgreSQL

   Bando needs a database to persist documents. The command below creates a local PostgreSQL instance using Docker.

   BASH

   Copiar

   1docker run --name bando-postgres -e POSTGRES_USER=bando -e POSTGRES_PASSWORD=bando -e POSTGRES_DB=bando -p 5432:5432 -d postgres:16-alpine

3. 3. Start Bando

   Now start the runtime in development mode:

   BASH

   Copiar

   1npx bando dev

   The runtime will be available at:

   TEXT

   Copiar

   1http://localhost:3333

   Studio is available at:

   TEXT

   Copiar

   1http://localhost:3333/admin

Next step

Now that the project is running, let us define the content types your application needs.