README.md

AIKON bundle version

This is a bundle version of the AIKON platform : a tool for humanities scholars leveraging artificial intelligence and computer vision methods for analyzing large-scale heritage collections.

About the AIKON platform

This repo contains the code for the platform + the worker API, allowing the whole to be easily installed and run on your local machine.

General requirements

• Sudo privileges
• Python >= 3.10
• Git:
  • sudo apt install git
  • Having configured SSH access to GitHub

Install 🛠️

Please refer to aikon/README and discover-api/README for detailed instructions (especially step-by-step install).

1. To install the API and Front application inside the aikon and discover-api folders, run:

   bash setup.sh

2. Define the .env variables to fit your requirements: For front application (aikon/app/conf/.env), notably

   # Folder where the media files are stored
   MEDIA_DIR=/home/path/to/aikon-bundle/aikon/app/mediafiles

   For the API (discover-api/.env), notably

   # Folder where the data is stored
   API_DATA_FOLDER=data/

3. To start everything in one killable process, run (after installing each part like advised in the subfolders):

   bash run.sh