Installation Guide

Getting Started

Installation Steps:

Fork it Repo:https://github.com/shiksha-platform/backend-v2

Clone it Git clone https://github.com/shiksha-platform/backend-v2.git

Once you have cloned the backend-v2 repository in GitHub, move to that folder first using the directory command.

cd backend-v2

Set it up Run the following commands to see that your local copy has a reference to your forked remote repository in GitHub git remote -v

By running the above command, you can see that the local copy has a reference to the forked remote repository in GitHub.

origin https://github.com/Your_Username/backend-v2.git (fetch)

origin https://github.com/Your_Username/backend-v2.git (push)

Run it Install dependencies

npm install

npm run start:dev

Test it Browse http://localhost:3000/api/swagger-docs/

Folder Structure:

Example of trackAssessment src/trackAssessment/

• src/trackAssessment/trackAssessment.controller.ts
• src/trackAssessment/trackAssessment.module.ts
• src/trackAssessment/dto/trackAssessment.dto.ts
• src/adapters/sunbird/trackAssessment.adapter.ts

DTO File:

DTO file will have all the schema for the assessment and DTO will transform the data to the specific DTO's properties, and return the transformed data.

Adapter File:

The adapter is the service layer that will have the logic to connect to the backend.

Controller File: The controller allows us to write the endpoints.

Module File: The module allows us to set the providers and controllers.