Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

48 lines (37 loc) · 1.85 KB
Raw

Contributing

Please also see the contribution guide in the root folder.

Prerequisites

Setup for local development

  • Start the database by running docker compose up in this directory
    • You can use docker compose --profile dev up if you want to start the testing database as well
  • Start the development server with yarn dev
  • You can now access the annotation interface app on localhost:3002

If you use kitty, you can conveniently run the dev script from this directory to start the database (& testing database), and the development server in split windows and open Anni in your browser.

Deploying

To deploy Anni, first ensure you have all environment variables set up. See .env.example for help. Then, run the following command from the repo's root:

docker compose --file anni/docker-compose.yaml --profile production up -d

This will run Anni without the Backupper. To run the Backupper as well, see the Deploying with Backupper section in its README.

The -d option will start Docker compose in the background.