🚧
Database (DB)
ShortURL | Playbook | Assistant
NOTICE
This documentation page is under construction. Should you want to be notified once it's published, let us know.

About

DOCUMENTATION STAGE: WIP - This documentation page is still a work in progress.

Project Lockdown: DataBase module

Table of Contents

  1. 1.
    About this module
  2. 2.
    The module in Project Lockdown
  3. 3.
    General overview of the module
  4. 4.
    Accessing the module
  5. 5.
    Contributing
  6. 6.
    More information
​

About this module

The DataBase module is responsible for storing all the data from the DataSet Layers and the configuration of the project modules. Information is obtained via APIs (see API module), which are also tasked to ensure the necessary access controls.
The DataBase is build on top of MongoDB and all the data is retrieved in JSON format. For more details on the JSON object schemas, see Schemas​
Back to top

The module in Project Lockdown

The following diagram showcases how this Module integrates in the project:
​
​
Back to top

General overview of the module

The following diagram showcases the general design of the Database module:
[WIP]
Back to top

Accessing the module

To access the DataBase, please visit https://DB.ProjectLockdown.world (Status: Under development)
Back to top

Contributing

The open GitHub Issues can be found here:
Pending tasksv(Labels: Module:DB + Stage: Ready) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Module%3A+DB%22+label%3A%22Stage%3A+Ready%22
Tasks in progress (Labels: Module:DB + Stage: In Progress) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Module%3A+DB%22+label%3A%22Stage%3A+In+Progress%22
Upcoming tasks that are being prepared (Labels: Module:DB + Stage: Not Ready) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Stage%3A+Not+Ready%22+label%3A%22Module%3A+DB%22
Back to top