Folder Structure

ML Survey Service folder structure is designed to organize the different modules and files that constitute the core service of the Learn application. It follows a modular approach, facilitating easy management and development of the service.

The structure is as follows

.
├── DBSchema
├── ansible
├── config
│   └── db
├── controllers
│   ├── v1
│   └── v2
├── generics
│   ├── helpers
│   ├── httpStatusCodes
│   ├── kafkaConsumers
│   ├── messageConstants
│   ├── middleware
│   │   └── validator
│   └── services
├── healthCheck
├── keycloak-public-keys
├── migrations
├── models
├── module
│   ├── assessments
│   │   └── validator
│   ├── criteria
│   │   └── validator
│   ├── criteriaQuestions
│   ├── dataPipeline
│   │   └── validator
│   ├── entities
│   │   └── validator
│   ├── entityAssessorTracker
│   ├── entityAssessors
│   │   └── validator
│   ├── entityTypes
│   ├── forms
│   ├── frameworks
│   │   └── validator
│   ├── insights
│   │   └── validator
│   ├── library
│   │   ├── categories
│   │   ├── individualAssessments
│   │   │   └── validator
│   │   ├── institutionalAssessments
│   │   │   └── validator
│   │   ├── observations
│   │   │   └── validator
│   │   ├── search
│   │   └── surveys
│   │       └── validator
│   ├── mediaFiles
│   │   └── validator
│   ├── observationSubmissions
│   │   └── validator
│   ├── observations
│   │   └── validator
│   ├── pollSubmissions
│   │   └── validator
│   ├── polls
│   │   └── validator
│   ├── programOperations
│   │   └── validator
│   ├── programUsers
│   ├── programs
│   │   └── validator
│   ├── questions
│   ├── reports
│   │   └── validator
│   ├── scoring
│   ├── shikshalokam
│   ├── solutions
│   │   └── validator
│   ├── staticLinks
│   │   └── validator
│   ├── submissions
│   │   └── validator
│   ├── surveySubmissions
│   │   └── validator
│   ├── surveys
│   │   └── validator
│   ├── userExtension
│   │   └── validator
│   ├── userRoles
│   │   └── validator
│   └── users
├── public
├── release-notes
├── routes
└── test

DBSchema

This directory is likely designated for housing files or documentation that pertain to the structure and design of the database schema.

ansible

Within this folder, users can find files pertaining to the orchestration of infrastructure and configuration processes, potentially utilizing Ansible. These files may relate to tasks like deployment or the setup of servers.

config

Within this folder, you can find configuration files specific to the core service, such as database configuration and other settings.

controllers

The controllers folder contains various modules representing the application's endpoints or routes. It is organized into different versions, denoted as "v1" and "v2," to allow for backward compatibility and feature evolution.

databaseQueries

Containing files related to database queries or operations aimed at retrieving data.

generics

This folder is dedicated to generic utilities and helper functions utilized throughout the core service. It includes subdirectories for constants, helpers, HTTP status codes, Kafka-related code, middleware (e.g., request validation), and services.

healthCheck

This folder is designated to hold files that pertain to health checks or monitoring endpoint, ensuring the service's health and availability is monitored effectively.

migrations

This folder houses database migration scripts, enabling smooth transitions between different versions of the database schema.

models

This folder contains the data models and database schema definitions for the core service.

module

The "module" folder consists of individual folders for each controller. Within each controller folder, there is a "helper" file that contains all the business logic for that specific controller. Additionally, there is a "validator" folder dedicated to API validation, ensuring that incoming data meets the required criteria and is sanitized appropriately.

release-notes

This folder contains release notes or changelogs that document the changes made in each version of the core service.

routes

The "routes" folder contains a single file named "index" that serves as the central location for all routes in the core service. These routes are created dynamically, making it a dynamic and flexible approach to managing the service's endpoints.

test

The test folder contains test files, including unit tests and integration tests to ensure the reliability and correctness of the core service.