[Feature] Docs for contributors

[Abbhiishek]

Hello,

This project has a backend service made purely in django and postresql db. The api and methods are not clear and its difficult for new bies to get started with the project.

Solution

We can host an external docs page backed by us to provide an open environment to test the api and use limited api calls. The docs would include all the details about the request body and response schema which might help me developer to get started with the project :)

Leaving this issue as a discussion on how we can aim this feature and proceed with the stuff.

[Sandesh-03]

please assign this issue to me

[Abbhiishek]

Sure @Sandesh-03 ,

what your approach toward the issue..

[Sandesh-03]

Sure, firstly I will give the project setup guide and then I will explain the work of the important methods and then how we can contribute to it

[Abbhiishek]

Sure, firstly I will give the project setup guide and then I will explain the work of the important methods and then how we can contribute to it

Hey @Sandesh-03 the project setup guide is already available and there are some plan to push more enriched ones. This issue was related to an external site explaining every routes and their schema for backend.

Let me know what you think of it

[Sandesh-03]

Ok, then we can add some examples regarding that.

[Abbhiishek]

Go ahead @Sandesh-03