Project Structure

The main configuration is available in the root of the project.

Directory Structure

├── docs               < Repo Documentation
├── env_scripts        < Scripts to generate config from env variables
├── public             < Files required to be in public dir
│   ├── locales        < Locale Translations
│   └── static         < Static files (images, etc.)
├── resources          < Git Hooks
├── src                < Main source code
│   ├── App            < Main App component
│   ├── components     < Reusable components for the UI
│   ├── hooks          < Custom React hooks
│   ├── mockData       < Data used for local testing
│   ├── pages          < Top-level page components
│   ├── services       < Shared services (API, i18n, etc.)
│   ├── types          < TypeScript type definitions
│   └── utils          < Utility functions
└── tests              < Unit and integration tests
    ├── unit           < Unit tests for components, services, and utils
    └── cypress        < Cypress E2E tests

Configuration

Configuration is done in several files, depending on what needs to be configured.

├── docs
│   └── src
│       └── conf.py                 < Documentation configuration
├── env_scripts                     < Script to generate config from env variables
├── public
│   ├── locales
│   │   └── en
│   │       └── qaDisplay.json      < Translation configuration
│   ├── index.html                  < Main HTML page
│   ├── manifest.json               < React Manifest
│   └── robots.txt                  < Robot configuration
├── resources                       < Git hooks
│   └── git-hooks
│       └── pre-commit              < Auto styling
├── src
│   ├── mockData                    < Mock data for the various endpoints
│   │   ├── Statistics
│   │   │   ├── processingBlock.ts
│   │   │   └── receiverEvents.ts
│   │   └── WebSocket
│   │       ├── phase.json
│   │       └── spectrum.json
│   │   └── tel-model
│   └── env.ts                      < Environment Variable Config
├── .dockerignore
├── .env                            < The environment variables to use (Ignored by Git)
├── .eslintignore
├── .eslintrc.js
├── .gitattributes
├── .gitignore
├── .gitlab-ci.yml                  < GitLab CI config
├── .gitmodules
├── .npmrc
├── .prettierignore
├── .prettierrc
├── .readthedocs.yaml               < RTD CI config
├── .release                        < The version details
├── bumpver.toml
├── CHANGELOG.rst
├── CODEOWNERS                      < Who can write to the code
├── CONTRIBUTORS
├── cypress.config.js
├── cypress.d.ts
├── Dockerfile                      < The build script for the Docker image
├── index.html
├── jest.config.ts
├── LICENSE
├── Makefile
├── nginx.conf
├── package.json
├── poetry.lock                     < Poetry config for documentation
├── pyproject.toml                  < Poetry config for documentation
├── README.md
├── tsconfig.cypress.json
├── tsconfig.json
├── vite.config.mjs
├── vitest.config.ts
└── yarn.lock

The package.json file lists all the packages and libraries used in this project.

To our knowledge, none of the packages or libraries used in this project require any license. Please let us know if any package or component requires a license or acknowledgement.