navigator-admin-backend

Backend for the Admin webapp

Getting started

Global dependencies

These are global tools and libraries that are required to run the backend:

• trunk
• poetry
• awscli
• docker

If you have not run the bootstrap previously run:

    make bootstrap

Development

To get a running version of the API on http://localhost:8888 run:

    make dev

To run the full test suite run:

    make test

To run unit tests without Docker run:

    make unit_tests

    # a specific file
    make unit_tests UNIT_TEST=tests/unit_tests/routers/ingest/test_bulk_ingest.py

    # a specific function / expression
    make unit_tests UNIT_TEST='tests/unit_tests/routers/ingest/test_bulk_ingest.py::test_bulk_ingest -k bulk_ingest'

To run integration tests (Docker) run:

    make integration_tests

    # a specific suite/file
    make integration_tests INTEGRATION_TEST=tests/integration_tests/collection

    # a specific function / expression
    make integration_tests INTEGRATION_TEST='tests/integration_tests/collection/test_update.py::test_update_collection -k update'

Background

This repository along with the frontend repository forms the necessary components that make up the Admin Pages/Interface/Service. These pages will provide the ability to edit Documents, Families, Collections and Events (DFCE). At the moment an MVP is being worked on that will have limited functionality, the specification can be found on the CPR notion pages here: MVP Admin Interface. Also on the notion pages is the Admin API Specification.

Issues / Progress

See the linear project.

Developers

If you are new to the repository, please ensure you read the getting starting guide and the design guide.

Bulk Import

For the full procedure on how to do a bulk import of data see this document.