Backend Server Documentation

This is the documentation for our backend server.

Table of Contents

• Project Structure
• Data Files
• Coverage Report
• Server Implementation
• API Routes

Project Structure

The project is structured as follows:

.
├── Data
│   ├── projects.json
│   ├── tabData.json
│   ├── profile.json
│   ├── toDoDate.json
├── coverage
│   ├── lcov-report
│   │   ├── index.html
│   │   ├── server.js.html
├── src
│   ├── middleware
│   │   ├── index.js
│   ├── server.js
│   ├── utils
│   │   ├── utils.js
│   ├── models
│   │   ├── UserSchema.js
│   │   ├── SettingsSchema.js
│   ├── controllers
│   │   ├── UserController.js
│   │   ├── SettingsController.js
│   ├── views
│   │   ├── index.ejs
│   │   ├── error.ejs
│   │   ├── profile.ejs
│   ├── routes
│   │   ├── api
│   │   │   ├── userRoutes.js
│   │   │   ├── settingsRoutes.js
│   ├── services
│   │   ├── auth.js
├── .eslintrc.json
└── README.md

Data Files

The Data directory contains JSON files that store different kinds of data:

• projects.json: Contains information about the projects.
• tabData.json: Stores data related to different tabs in the project.
• profile.json: Contains user profile data.
• toDoDate.json: Stores data related to the to-do list.

Coverage Report

The coverage directory contains reports generated by the test coverage tool. It provides a detailed view of what parts of your codebase are covered by your tests.

Server Implementation

The server is implemented in the src directory. It consists of different modules for models, controllers, views, routes, and services:

• server.js: This is the main server file which includes the necessary middleware, routing, error handling, and server start functionality.
• middleware/index.js: Contains all the middleware used in the application.
• models: This directory contains all the data models used in the application.
• controllers: This directory contains all the controllers which handle the business logic of the application.
• views: Contains the EJS template files for rendering data on the front-end.
• routes: Defines the application’s routes and maps them to the appropriate controllers.
• services: Contains various services used across the application, such as authentication.

API Routes

Our server provides the following main API endpoints:

• User routes (/api/user): Handles user-related operations.
• Settings routes (/api/settings): Handles operations related to user settings.

For more detailed information on these routes, please check the individual route files in the src/routes/api directory.

Contribute

Before contributing, please read our contributing guidelines.

License

This project is licensed under the terms of the MIT license. For more information, please see the LICENSE file.

Contact

For any issues, please contact us at [email protected] or open an issue here.