Yashasv-Prajapati / Docify

5 stars 2 forks source link

Feature/cs3 155 api generate readme route handler #136

Closed Karanraj06 closed 2 months ago

Karanraj06 commented 2 months ago
linear[bot] commented 2 months ago
CS3-155 [API] Generate Readme route handler

Create if not created -> /api/readme/route.ts In this, you will have, project_description, project_type, project_id. Now you also need the dependencies for this project, so first check in the db, if there exists dependencies corresponding to the project_id. If NO, hit the API handler of dependency checker for that project, assume you have all that you need to pass to that API handler of dependency checker and then fetch the data from db of dependencies corresponding to that project_id. If YES, process ahead Use a free LLM endpoint, hugchat API is available for python or maybe something else like Google's makersuite or something, and provide that LLM with these following things 1. Project type 2. Project Description that you got in input from user 3. Project dependencies. Formulate a prompt based on these, use the dependencies as keywords and ask the LLM to generate a project description that can be put in the user's project README.md