Skip to content

🛠️ Setup

Learn how to spin up a Panoramax instance locally or with Docker. Panoramax instance website can be installed in two ways:

  • Classic installation (ideal for local development)
  • Docker installation (recommended for quick deployments)

Note

This guide covers the frontend only. If you also need the API, head to the Panoramax API docs.

🧰 Classic Installation (Local)

ℹ️ If you want to clean your repo and remove the lock files and the nodes_modules folder before using the package you chose you can run this command : 

rm -f yarn.lock package-lock.json pnpm-lock.yaml && rm -rf node_modules app/node_modules admin/node_modules

Requirements

Tool Version / Notes
Node.js ≥= 24.12.0 – Download
Package Manager pnpm (≥= 10.27.0), yarn, or npm

1. Clone the repository

git clone https://gitlab.com/panoramax/server/website.git
cd website/

2. Install dependencies

Package Manager Command
pnpm pnpm install
yarn yarn install
npm npm install

ℹ️ If you have some package manager warning or error this could be related to the need to change the packageManager type in the package.json file.

3. Configure environment variables

Create your own .env file from the template:

cp env.example .env

💡 Check the Settings documentation page for the full list of available env vars.

4. Run in developpement

4.1 Run the main frontend application

Package Manager Command
pnpm pnpm dev:app
yarn yarn dev:app
npm npm run dev:app

4.2 Run the admin frontend

Package Manager Command
pnpm pnpm dev:admin
yarn yarn dev:admin
npm npm run dev:admin

Your website will be accessible at 👉 http://localhost:5173

5. Build and run in production

Package Manager Command
pnpm pnpm build
yarn yarn build
npm npm run build

Then start the server on port 3003:

node server.js

Your website will be accessible at 👉 http://localhost:3003

🐳 Docker Installation

The Docker workflow is the fastest way to deploy the Panoramax frontend.

Option A — Use the official image

docker run \
  -e VITE_API_URL="https://my-panoramax-api.fr/" \
  -e VITE_TILES="https://my-panoramax-api.fr/vector/tiles/style.json" \
  -p 3000:3000 \
  --name panoramax-website \
  -d \
  panoramax/website:latest

Your instance will be available at 👉 http://localhost:3000

Option B — Build the image yourself

docker build -t panoramax/website:latest .

Then run the container using the same command as above.

✅ Next Steps