MTouthang / server

lmsGenie backend

💫 lmsGenie Back-End 💫

This repository contains code and resources dedicated to the development and maintenance of the backend component of the lmsGenie application.

Getting Started

Below steps will guide you, how to set up your project locally. To get a local copy up and running follow these simple example steps.

1. Install pnpm

npm i -g pnpm

2. Clone repo locally.

git clone https://github.com/lmsGenie/server.git

3. Install dependencies

pnpm i

4. Run project locally

pnpm run dev

Database Design

Checkout our Database Design.

Project Structure

1. Code files

• src/: Contains all source code files.
• src/controller/v1/: Defined controllers functions.
• src/models/: Defined Schemas and Models.
• src/routes/v1/: Defined API routes.
• src/services/: Defined helper services (eg. email service)
• src/middlewares/: Defined middleware functions.
• src/config: Defined API related configs here (eg. DB configs).
• src/validations/: Defined zod validations.
• src/enums/: Defined enum constants.
• src/logger/: Defiled winston logger.
• src/utils/: Reusable utility function/constants.
• src/helpers/: Reusable helper function/contants.

2. Config files

• jest.config.js: Jest config.
• .eslintrc.json: Eslint config.
• .eslintignore: Esline ignore.
• commitlint.config.js: Commitlint config.
• prettier.config.js: Prettier config.
• .prettierignore: Prettier ignore.
• tsconfig.json: Typesctipt config.
• package.json: Project dependencies.
• .husky: Husky config files.

Want to contribute?

Feel like contributing? That's awesome! We have a contributing guide to help guide you.

Want to discuss something? Create a discussion