Skip to content

Introduction

Antares Web is developed mainly in Python and uses FastAPI web framework. The front end is a React web application. A local build allows using Antares Web as a desktop application.

Quick start

Requirements:

  • python : 3.11.x
  • node : 22.13.0
  • uv : latest (see installation)

Then perform the following steps:

  1. First clone the projet:
git clone https://github.com/AntaresSimulatorTeam/AntaREST.git
cd AntaREST
  1. Install back-end dependencies using uv:
# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install all dependencies (production, test, and dev)
uv sync --all-extras
  1. Install dependencies to build the front end:
cd webapp
npm install
npm run build
cd ..

IMPORTANT : make sur the generated files are in the dist (or build) folder. Using another folder may require substantial adaptations in the CI/CD pipelines.

  1. Run the application
uv run python antarest/main.py -c resources/application.yaml --auto-upgrade-db --no-front

Deploy

See server application: