Skip to content

Comments

feat: Documentation for Backend and Front-end APIs and in general#72

Open
Anurag-Bansode wants to merge 10 commits intoSrinjoyeeDey:mainfrom
Anurag-Bansode:feature/docs
Open

feat: Documentation for Backend and Front-end APIs and in general#72
Anurag-Bansode wants to merge 10 commits intoSrinjoyeeDey:mainfrom
Anurag-Bansode:feature/docs

Conversation

@Anurag-Bansode
Copy link
Contributor

@Anurag-Bansode Anurag-Bansode commented Oct 9, 2025

Hi @SrinjoyeeDey .
I have add the documentation for the backend; the developer just have to follow the template in previous code and same can be available on http://localhost:4000/api-docs
Frontend developer the can create exact objects which can also be tested via Swaggers Testing mechanism

Additional changes have been mention in readme.md

Just for Reference

Backend Documentations:

The Backend Documentation is generated using SwaggerUI
run

npm run dev

command
and now the documentation is available at http://localhost:4000/api-docs.
Frontend developer can refer to the same to create json objects.

Frontend Documentations:

The Frontend Documentation is generated using Typedoc and tsdocs and can be build using

npm run docs

command.

The outputed static files will be available in /docs folder

The diff is long however all are just comments.

Please Note: changes have been made to package.json which include the following

Frontend: in scripts - new script added for doc generation
Backend: two swagger packages have been added

closes #68

@Anurag-Bansode Anurag-Bansode changed the title Feature/docs feat: Documentation for Backend and Front-end APIs and in general Oct 9, 2025
@Anurag-Bansode
Copy link
Contributor Author

Hi @SrinjoyeeDey, I have update the branch to the latest merge performed.
Requesting you to merge at the earliest.

@Anurag-Bansode
Copy link
Contributor Author

@SrinjoyeeDey requesting you to review this PR and merge it at the earliest.
Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Documentation for Backend and Front-end APIs and in general

1 participant