Prerequisites

Preparing your local environment#

Our project is written in Typescript and is based on Node.js. For development purposes you can either run our project fully native on your machine or run it in docker using our docker-compose file. For either path please ensure the following things are installed on your local system:

• Node.js: Download Node.js v24.16.0 or higher (includes npm)
• PNPM: Download PNPM
• Docker: Download Docker
• Docker Compose: Install Docker Compose plugin
• CodeEditor or IDE: We have had good experience with VSCode as well as Intelij IDEA.
• (Optional) wscat: Download wscat (to manually test websocket connections to CitrineOS)