Skip to content

C241-MS01/dms-web-backend

Repository files navigation

DMS Web Backend

Description

This is the backend application for the Driver Monitoring System (DMS) web application. It is built using Node.js, the Express web framework, and the Prisma ORM. It is responsible for serving the web application, handling user authentication, and managing the data stored in the MySQL database.

Documentation

Application Architecture

The application is structured as follows:

Application Architecture

API Documentation

The API documentation is hosted on Postman Documenter.

Database Schema

The database schema is managed using Prisma Migrate. The schema is defined in the schema.prisma file.

Getting Started

  1. If you do not use devcontainer, ensure you have Node.js version 20 or higher installed:

    node -v
  2. Install the required NPM packages:

    npm install
  3. Create a copy of the .env.example file and rename it to .env:

    cp .env.example .env

    Update the configuration values as needed.

  4. Ensure the MySQL database is running and the schema is created:

    npm run migrate:dev
  5. Run the application:

    npm run dev

License

This project is licensed under the MIT License, providing an open and permissive licensing approach for further development and distribution.