aiiinotate

aiiinotate is a fast and lightweight annotation server for IIIF. It relies on nodejs/fastify and mongodb and provides an API to read/write/update/delete IIIF annotations and index manifests.

PROD USAGE

Install

1. Install mongodb.

   • see dev installation script for help
   • checkout the official installation guide

2. Install aiiinotate

npm install aiiinotate

Setup the app

0. Setup your .env file after .env.template.

1. Start mongod

sudo systemctl start mongod

2. Create and configure the database

aiiinotate --env <path-to-your-env-file> -- migrate apply

Usage

All commands are accessible through a CLI (./src/cli).

Run the app

aiiinotate --env <path-to-your-env-file> -- serve prod
# or 
aiiinotate --env <path-to-your-env-file> -- serve dev

Run administration commands

The base command is:

aiiinotate --env <path-to-your-env-file> -- <command>

It will give full access to the CLI interface of Aiiinotate. Run aiiinotate --help for more info.

1. Import data - TODO

DEV USAGE

Install

# clone the repo
git clone [email protected]:Aikon-platform/aiiinotate.git

# move inside it
cd aiiinotate

# install mongodb
bash ./scripts/setup_mongodb.sh

# install node
bash ./scripts/setup_node.sh

# install dependencies
npm i

Setup

After installing, some setup must be done

0. Setup your .env file after .env.template and place it at ./config/.env.

1. Start mongod

sudo systemctl start mongod

2. Configure the database

npm run migrate apply

Usage

Remember to have your mongodb service running: sudo systemctl start mongod !

• Start the app

npm run start

• Test the app

npm run test

• Run the CLI

npm cli

• Process migrations

# create a new migration. NOTE: the `--` is necessary !
npm run migrate make -- --migration-name <your migration name>

# apply all pending migrations
npm run migrate apply

# revert the last migration
npm run migrate revert

# revert all migrations
npm run migrate revert-all

License

GNU GPL 3.0.