Skip to content

mozilla-it/ctms-api

Repository files navigation

ConTact Management System (CTMS)

While the app is running, interactive API documentation can found at the following relative paths: /docs, /redoc.

OpenApiSpec(OAS) formatted in JSON can be found at the following path: /openapi.json


View All Docs


Prerequisites

Please read the Developer Setup documentation before developing
for this project to ensure correct environment setup.


Project Structure

The project is structured with the following in mind:

  • bin/*
    • Some scripts that have proven useful within the CTMS ecosystem
  • docs/*
    • Documentation to guide others around the project interactions
  • ctms/*
    • Application logic lives within this directory
    • bin/*
      • Scripts intended for background machinery
    • schemas/*
      • Pydantic Models for Data Modeling and Contract Validation
  • migrations/*
    • Alembic migrations that act as a changelog or version control system for implementing DB changes in an ordered fashion
  • tests/unit/*
    • Test suite using pytest

Important Files

Below are some files that are worth making note of:

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages