ontoportal / ontoportal_docker

Scripts for running and developing OntoPortal with docker
2 stars 1 forks source link

Update ontoportal docker to use docker compose of the ui and api #6

Closed imadbourouche closed 6 months ago

imadbourouche commented 10 months ago

Prequisities

Proposition

The Ontoportal_docker repository has simplified the way ontoportal development works by containerizing the appliance component (API, UI ...etc).

The main goal of this PR is to make a one-click solution designed to simplify the Running and deployment of the Ontoportal appliance. This script streamlines the process of setting up and running the Ontologies API and User Interface (UI) components on your local machine or deploying it on a remote server.

This script also gives the user the ability to make his own configuration that has to be in the .env file. So it has two modes:

You can find here the full documentation: Documentation

Demonstration Video: Demo

How it works

just run ./ontoportal help to see the help

➜  ontoportal_docker git:(main) ./ontoportal help
Usage: ./ontoportal <command>

Commands:
  start   : Start the ontologies API and UI (Default Mode / Personilized Mode)
  deploy  : Deploy the application using Kamal to the server
  stop    : Stop the API and UI services
  clean   : Clean up the server (remove ontologies_linked_data, docker-compose files, and remove all containers)
  help    : Show this help message

Additional notes:
- You can provide your own .env file to customize parameters:
  Just put the .env file in this directory and run ./ontoportal start

Run The appliance (API + UI)

./ontoportal start

Stop The appliance (API + UI)

./ontoportal stop

Clean The server: this will remove all docker-compose files and containers

./ontoportal clean

Deploy The appliance on a server: this will deploy the api and the ui on a server using configuration in .env file

./ontoportal deploy
syphax-bouazzouni commented 10 months ago

Also, you(@imadbourouche) need to add the .env.sample file of the ontoportal docker