Smart City Suite

Local Development

To run the application locally, make sure all the prerequisites are installed (Rancher Desktop, Node.js (v.20.13.0), PgAdmin/DBeaver, K9S) and then install the dependencies for all packages (npm install in root, frontend, microservices).

Afterwards you can continue the setup with kubernetes here.

Single Sign On

We use Keycloak as our Single Sign On (SSO) provider.

For local development, the SSO can be accessed at http://localhost:8080/.

You can find more information about the Auth here.

Database

Locally, we run a PostgreSQL database via kubernetes.

Before you can develop or test locally, you will need to setup the database and run the migrations:

• Local Setup

• Migrations

Microservices (backend)

The backend is composed of several NestJS microservices. They are all part of the same monorepo in the microservices directory.

The monorepo contains the following microservices:

• dashboard-service: Responsible for serving data to the frontend and handling configuration changes.

• ngsi-service: Responsible for handling requests that need to be made using the NGSI API.

• orchideo-connect-service: Responsible for handling requests that need to be made using the orchideo connect dataplatform.