Project Structure 0verview

Project structure of SSP Relay consist of different folders and files which has different target purpose.

The following are the folders inside the SSP Relay

Folder Name
Description

config

A folder that contains all the configuration and secrets needed by SSP Relay during runtime

helpers

A folder that contains all action helpers of SSP Relay

helpers

A folder that contains all action helpers of SSP Relay

logs

A folder being use as a location for generated logs by SSP Relay during runtime

src

A folder that contains all the API services used for SSP Relay

tests

A folder that contains all the test suites of the api services and services represented by spec files

The following are the files being used by SSP Relay before and during runtime

File Name
Description

.editorconfig

A file that declares formatting

.gitignore

A file that declares extension and folders to be ignored when committing to repository

.prettierrc

A file that declares pretty formatting

backup.ts

A file that contains code for backup and cleanup

eslint.config.js

A file that contains config for SSP Relay project JS and TS resources

index.ts

A file that contains server startup

package.json

A file that contains SSP Relay project dependencies

tsconfig.json

A file that contains TS functionalities and its restrictions

Last updated