Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add backend models graph build job #724

Open
arkid15r opened this issue Feb 3, 2025 · 17 comments · May be fixed by #989
Open

Add backend models graph build job #724

arkid15r opened this issue Feb 3, 2025 · 17 comments · May be fixed by #989
Assignees

Comments

@arkid15r
Copy link
Collaborator

arkid15r commented Feb 3, 2025

Describe the solution you'd like
Set up CI/CD job that will create/update Nest backend models relations image for further using in documentation.
The job should be triggered upon models files changes only and also manually.

@yashgoyal0110
Copy link
Contributor

@arkid15r, can i work on this issue?

@priyankaChauhan2804
Copy link
Contributor

hello, i would love to work on this issue, if possible, could you assign it to me?

@abhayymishraa
Copy link
Collaborator

could i work on it ? @arkid15r

@arkid15r arkid15r moved this from Todo to In progress in Project Nest Feb 3, 2025
@arkid15r
Copy link
Collaborator Author

@priyankaChauhan2804 any updates on this after 1 week?

@priyankaChauhan2804
Copy link
Contributor

priyankaChauhan2804 commented Feb 11, 2025

yes, just having some problem in my github, will be raising a pr asap. Sorry for the delay

@arkid15r
Copy link
Collaborator Author

yes, just having some problem in my github, will be raising a pr asap. Sorry for the delay

okay, I extended the deadline to Fri.

@priyankaChauhan2804
Copy link
Contributor

yes, thank you @arkid15r , again sorry for the delay

@arkid15r arkid15r moved this from In progress to Todo in Project Nest Feb 13, 2025
@Raghavg18
Copy link
Contributor

@arkid15r can u assign this to me?

@moodyadi2006
Copy link
Contributor

Hey @arkid15r,
I am now ready to work on this issue and would appreciate it if you could assign it to me.
My Approach:
I plan to create/update the Nest backend models' relationship image for use in documentation. The job will be triggered upon changes to model files and also manually. To achieve this, we will use pygraphviz to generate an Entity-Relationship Diagram (ERD) and pydot to visualize it for documentation purposes.
Additionally, I have set up a CI/CD pipeline that automates ERD generation and stores the diagrams in the erdImages folder using the generate-erd.py script in the backend.
If my approach needs any modifications, please let me know. Looking forward to your feedback!

@arkid15r
Copy link
Collaborator Author

I'm not sure if all that needed, I though it'd be easier with django-extensions. Maybe I'm wrong.

@arkid15r arkid15r moved this from Todo to In progress in Project Nest Feb 14, 2025
@moodyadi2006
Copy link
Contributor

Yes @arkid15r you are correct, it is easier with django-extensions, I am ready to merge PR.
This is how the ERD is looking like

Image

@arkid15r arkid15r linked a pull request Feb 15, 2025 that will close this issue
@arkid15r arkid15r moved this from In progress to Todo in Project Nest Feb 18, 2025
@harsh3dev
Copy link
Collaborator

@arkid15r I would like to take this one if it's open

@arkid15r arkid15r moved this from Todo to In progress in Project Nest Feb 19, 2025
@arkid15r
Copy link
Collaborator Author

@harsh3dev any updates on this?

@harsh3dev
Copy link
Collaborator

I am not able to tackle this due to some unforeseen circumstances.
Anyone else interested can take this
Thanks

@yashgoyal0110
Copy link
Contributor

@arkid15r
I want to take this issue

@Dishant1804
Copy link
Collaborator

@arkid15r i would like to work on it

@arkid15r arkid15r assigned Dishant1804 and unassigned harsh3dev Feb 25, 2025
@Dishant1804
Copy link
Collaborator

@arkid15r you can assign this to someone else as i am not available till 3rd of march due to exams
Thank you :)

@arkid15r arkid15r moved this from In progress to Todo in Project Nest Mar 1, 2025
@arkid15r arkid15r moved this from Todo to In progress in Project Nest Mar 1, 2025
@yashgoyal0110 yashgoyal0110 linked a pull request Mar 3, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In progress
8 participants