Download
You can download and install the current version v0.6.5 using the installer links below.
See https://github.com/aarkue/OCPQ/releases for more releases and installer versions.
Docker
Alternatively, you can also run OCPQ using Docker. This requires a local installation of Docker on your machine. To use OCPQ with Docker, simply follow the instructions at https://github.com/aarkue/OCPQ/?tab=readme-ov-file#docker.
The docker deployment will start a local web server for the backend and the frontend. Once the container is running, you can open http://localhost:4567/ in your browser for the tool frontend. The backend will by default run at http://localhost:3000/.
Docker Compose
Run docker compose up --build
in the project root.
Alternatively, the docker files can of the frontend and backend can also be used separately:
Docker Files
- backend:
- First build using
sudo docker build ./backend -t ocedeclare-backend
- Then run with
docker run --init -p 3000:3000 ocedeclare-backend
- First build using
- frontend:
- First build using
sudo docker build ./frontend -t ocedeclare-frontend
- Then run with
sudo docker run --init -p 4567:4567 ocedeclare-backend
- First build using
Development / Run Manually
To run OCPQ manually follow the development instructions at https://github.com/aarkue/OCPQ?tab=readme-ov-file#development.
We use cargo
and npm
, so please ensure they are available by installing them (i.e., Rust and Node).
Then, install all dependencies (e.g., using npm i
inside the frontend
folder)
For the full-stack web application navigate to the backend
folder and run cargo run --release
to start the backend and navigate to the frontend
folder and execute npm run dev
to start the frontend.
By default, the backend server is available at http://localhost:3000
while the frontend is available at http://localhost:5173/
.
For the desktop application, tauri (https://tauri.app/) is used.
To run the desktop application, simply run npm run tauri dev -- --release
inside the tauri
folder.