README.md

Developer documentation

This directory contains documentation for developers.

Getting started

• First time setup -> start here!
• Overview of the source code
• Notes for development

Adding corpora

• Corpus definitions
• Corpus database models
• Writing a corpus definition in Python
• Elasticsearch index settings
• Indexing corpora
• Indexing in deployment
• Corpus validation
• Writing documentation for corpora

Feature development

Backend and API

• Celery (used for downloads and visualisations)
• Email (used for downloads and authentication)
• Downloads
• Adding word models
• Query API

Frontend

• Deep routing and state management

Authentication

• Authentication and authorisation
• Email (used for downloads and authentication)
• SAML

Making releases

• Versioning
• Making a release