DOCSEARCHbyAlgolia
Submit Docs

Smart Campus App Documentation

website·Indexed 29 days ago

https://smart-campus-4ut.pages.dev

Technical documentation for the Smart Campus App, a modern platform built to streamline communication. The documentation covers the application's architecture, including Mongoose schemas for users, classrooms, subjects, and assignments, Express routers, controller functions, and core services. It also details system components such as background jobs, NFC reader entries, JWT utility functions, and a pino-based logging system.

Tokens
15.2K
Snippets
70
Records
176
Agent score
74%

What's inside Smart Campus App

  1. Overview of the TimeTable Controller

    The timeTable.controller.js file implements the controller layer for timetable management. It handles incoming HTTP requests and coordinates with ./timeTable.services.js to perform database operations for creating, retrieving, listing, updating, and deleting timetable records.

  3. Overview of subject core services

    The subject.services.js file provides a set of core services for interacting with the subjects collection in the database. These services abstract the database logic and provide a clean interface for the controller, relying on the ./subject.model.js Mongoose model.

  4. Overview of Assignment Core Services

    The assignments.services.js file provides a set of core services for interacting with the assignments collection in the database. These services abstract the database logic and provide a clean interface for the controller. It depends on the ./assignments.model.js Mongoose model.

  5. Overview of the background job system

    The application uses the bullmq library (built on Redis) in backgroundJobs.js to manage asynchronous and reliable task execution via message queues. It relies on a Redis connection object provided by ../constants.config.js and a custom logger from ../helper/logger.js.

  6. Overview of the Subject Controller

    The subject.controller.js file implements the controller layer for subject-related HTTP requests. It handles the orchestration between incoming requests and the underlying data services provided by ./subject.services.js to perform create, retrieve, list, update, and delete operations on subject records.

  7. Overview of studentTimeTable core services

    The studentTimeTable.services.js file provides a set of core services for interacting with the studentTimeTable collection in the database. It abstracts database logic to provide a clean interface for controllers, relying on the ./studentTimeTable.model.js Mongoose model.

  9. Overview of Classroom Core Services

    The classroom.services.js file implements a service layer that abstracts database logic for the classrooms collection, providing a clean interface for controllers to interact with the data. It depends on the Mongoose model defined in ./classroom.model.js.

  10. Overview of the Classroom Controller

    The classroom.controller.js file implements the controller logic for handling HTTP requests related to classrooms. It serves as the orchestration layer that calls the core data services defined in ./classroom.services.js to perform CRUD operations on classroom data in the database.

  11. Overview of the Scanner Controller

    The scanner.controller.js file implements the controller layer for handling HTTP requests related to scanners. It manages the creation, retrieval, listing, updating, and deletion of scanner records by interfacing with the core services defined in ./scanner.services.js.

  12. Overview of scannerCoreServices

    The scanner.services.js file exports a scannerCoreServices object that abstracts database logic for the scanners collection. It depends on the ./scanner.model.js Mongoose model and provides a clean interface for controllers to perform CRUD operations on scanners.