For current internal documentation, please visit: [TIOF PLD] Devs [I] API Guidelines ENG v1.0 (only for Project Lockdown members at the moment - Scheduled to be published) https://docs.google.com/document/d/19DcvhEj1f2m3mzuUYFufOPAHtNyqiQ_FHWncqGn85GQ/edit#heading=h.joekn2c04741
- About this module
- The module in Project Lockdown
- General overview of the module
- Accessing the module
- Contributing
- More information
The API module is a back end component that is responsible for providing all the necessary interfacing to manipulate Project Lockdown's data.
It handles the data operations between the Database (DB)
and
-
the Back office (BO)
(STAGE: IN PROGRESS) -
the Mapping Platform (MAP)
(STAGE: IN PROGRESS) -
the Data Entry Interface (DEI)
(STAGE: DEPRECATED)
It also allows for data access from 3rd parties in a number of differet formats.
The following diagram showcases how this Module integrates in the project:
The following diagram showcases the general design of the API module:
[WIP]
To get the MAP running locally, you will need to have Node.js installed.
Clone the repository.
git clone https://github.com/TheIOFoundation/ProjectLockdown.git
Navigate to the MAP folder.
cd ProjectLockdown
cd API
Install the required dependencies.
npm install
Create a .env file from the template .env.example file.
Run the app in development mode.
npm start
Runs the app in the development mode on Open http://localhost:4000/api/v2/ to view it in your browser.
To access the API, please visit https://API.ProjectLockdown.world (Status: Under development)
The open GitHub Issues can be found here:
Pending tasks (Labels: Module: API + Stage: Ready) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Module%3A+API%22+label%3A%22Stage%3A+Ready%22
Tasks in progress (Labels: Module: API + Stage: In Progress) https://github.com/TheIOFoundation/ProjectLockdown/issues?q=is%3Aopen+is%3Aissue+label%3A%22Module%3A+API%22+label%3A%22Stage%3A+In+Progress%22
Upcoming tasks that are being prepared (Labels: Module: API + 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+API%22
For all the necessary information please refer to the technical documentation in the wiki: https://github.com/TheIOFoundation/ProjectLockdown/wiki/Open-Data-API-(API)