Directory Structure

Directory structure

├── bin # PHP source code
│   ├── config # configuration file where to store passwords, tokens, ...
│   │   ├── database.php
│   │   ├── key.php
│   │   └── webhook.php
│   ├── core # main part of the REST API
│   │   ├── action.php # interface for any of the other actions
│   │   ├── auth.php
│   │   ├── create_repo.php
│   │   ├── create_server.php
│   │   ├── help.php
│   │   ├── server_get_job_info.php
│   │   ├── server_get_priority.php
│   │   ├── server_reserve_job.php
│   │   ├── server_set_job_done.php
│   │   ├── server_set_priority.php
│   │   ├── server_set_priority_done.php
│   │   ├── splitter.php # where the request is splitted to the needed action
│   │   └── welcome.php
│   ├── index.php
│   └── webhook.php
├── db # DB utilities
│   ├── database.sql
│   ├── functions-procedures # folder containing all the needed functions and procedures
│   │   ├── CreateRepo.sql
│   │   ├── CreateServer.sql
│   │   ├── CreateUpdateRemoveClient.sql
│   │   ├── GetClient.sql
│   │   ├── ServerGetJobInfo.sql
│   │   ├── ServerGetPriority.sql
│   │   ├── ServerGetPublicKey.sql
│   │   ├── ServerReserveJob.sql
│   │   ├── ServerSetJobDone.sql
│   │   ├── ServerSetPriority.sql
│   │   └── ServerSetPriorityDone.sql
│   └── tables # DB tables definition
│       ├── client.sql
│       ├── client_account.sql
│       ├── client_accounts_type.sql
│       ├── repo_declaration.sql
│       ├── repo_log.sql
│       ├── repo_status.sql
│       ├── server_list.sql
│       ├── server_priority_declaration.sql
│       ├── server_priority_instructions.sql
│       ├── server_priority_log.sql
│       ├── server_priority_status.sql
│       └── server_secrets.sql
└── docs # documentation
    ├── CHANGELOG.md
    ├── ERD.svg
    ├── LICENSE
    ├── README.md
    ├── rest-createstructure-Class-UML.svg
    ├── rest-createstructure-ER.svg
    └── rest-createstructure.drawio

7 directories, 49 files