Install Jjodel Locally

While Jjodel is designed as a cloud-native platform accessible at app.jjodel.io, you can also run it locally for offline use, development, or research purposes.

Option 1 — Docker (Recommended)

Docker is the fastest way to run Jjodel locally.

Prerequisites

Docker installed on your machine
Docker Compose (included with Docker Desktop)

Steps

Clone the Jjodel repository:

git clone https://github.com/jjodel-modeling/jjodel.git
cd jjodel

Start Jjodel with Docker Compose:
Terminal window
```
docker-compose up -d
```
Open your browser and navigate to http://localhost:3000 (or the port specified in the configuration)
To stop Jjodel:
Terminal window
```
docker-compose down
```

What’s Included

The Docker setup includes all Jjodel components: the web application, the backend services, and the database. It provides the same full-featured environment as the cloud version, except for shared storage and real-time cross-network synchronization.

Option 2 — Build from Source

For developers who want to contribute to Jjodel or customize it.

Prerequisites

Node.js (version 18 or later)
npm or yarn
Git

Steps

Clone the repository:

git clone https://github.com/jjodel-modeling/jjodel.git
cd jjodel

Install dependencies:
Terminal window
```
npm install
```
Start the development server:
Terminal window
```
npm run dev
```
Open your browser and navigate to the URL shown in the terminal (typically http://localhost:5173)

Development Notes

Jjodel uses React 18 + TypeScript with Vite as the bundler
Styling is done with SCSS
Icon library: Bootstrap Icons (the only permitted icon library)
Code editor: Monaco Editor

For development conventions and guidelines, see the CLAUDE.md file in the repository root.