Prophecies
APIGithubAbout ICIJAsk for help
  • Introduction
  • Ask for help
  • About ICIJ
  • Github
  • 🌐Getting Started
    • Installation with Docker
    • Key concepts
    • Configure Prophecies
  • ⚡User Guide
    • Upload data as an admin
      • Add a project
      • Add users
      • Add a task
      • Manage a task
    • Check data as a checker
      • Sign in or log in
      • Find a task
      • Read notifications
      • Check records
        • Read tutorial
        • Enter a choice
        • Enter a choice for multiple records
        • Change or cancel a choice
        • Leave a note
        • Open record in new tab
        • Duplicate record
        • Lock record
        • See record's history
      • Search records
      • Filter records
      • Sort records
      • Read shortcuts
      • Read tips
      • Read stats
      • Read history
      • Log out
    • FAQ
  • 🤓Developers
    • Installation from the sources
    • Architecture overview
    • Prophecies API
    • Testing the backend
    • Testing the frontend
    • Continuous integration
    • Publishing a new Docker image
Powered by GitBook

Prophecies is an open source project by the International Consortium of Investigative Journalists

On this page
  • API
  • Stack
  • Interaction workflow
  • Database schema
Export as PDF
  1. Developers

Architecture overview

PreviousInstallation from the sourcesNextTesting the backend

Last updated 1 year ago

API

The API is built with Django Rest Framework and implements the of Prophecies.

Stack

Prophecies is based on the following open source tools:

  • Python 3.9, 3.10

  • Node 16, 18

  • Django 4.2

  • Django Rest Framework 3.14

  • Django Rest Framework JSON:API 6.1

  • Pytest

  • Vue 2.7

  • Vue CLI 5

  • Vuex ORM 0.36

  • Jest 28

  • Poetry

  • Yarn

Interaction workflow

This sequence diagram illustrates the communication flow within the Prophecies platform infrastructure, focusing on how a request travels from the user interface to the database and back.

Database schema

Here is a simplified version of the Database schema.

🤓

Use this page to explore the latest specifications of the API.

The JSON:API spec is a standard for structuring JSON responses in APIs to optimize data exchange and efficiency.

key concepts

This schema follows the . You can load this file in many OpenAPI clients, including Swagger or Redoc.

Explore the API
Download API schema
OpenAPI 3
JSON:API specification