API Code Refactoring: 2024 - 2025 Readability and Maintainability

[palisadoes]

In the past 12 months we have added many new features to the repository. This has made Talawa much more usable.

Last year we improved the installation procedures with better setup scripts, videos and text documentation. This has made it much easier for new contributors to get started, but we can do more. We are close to completing our code base auto generated documentation process which will help too.

We will soon be ready for our first alpha testers.

In preparation for this we should start thinking about ways to refactor the code to make it more maintainable and readable for both new and existing contributors.

How can we refactor our code base to do this?

[varshith257]

@palisadoes Here's going on some interesting discussion about code refactoring. Please find here #2011 (reply in thread)

[varshith257]

@palisadoes I have seen many organisations are adding code tours of their codebase using VS Code extensions. Can we get around it?
It will surely help new contributors to understand the codebase easily without any difficulty.
refer this

[palisadoes]

1. Guide: GraphQL Yoga / Apollo Server with Server Preset
2. Code Walkthroughs