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 : 18.16.1
Then perform the following steps:
- First clone the projet:
git clone https://github.com/AntaresSimulatorTeam/AntaREST.git
cd AntaREST
- Create and activate a Python virtual environment:
python3 -m venv venv
source venv/bin/activate
- Install dependencies to build, test or develop the back end:
python3 -m pip install --upgrade pip
pip install -e . # to install in development mode (editable)
pip install -r requirements-dev.txt # production, unit tests and development requirements
- 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
(orbuild
) folder. Using another folder may require substantial adaptations in the CI/CD pipelines.
- Run the application
python3 antarest/main.py -c resources/application.yaml --auto-upgrade-db --no-front
Deploy¶
There are 2 ways to use and/or deploy the application: