Repository cleanup #42
Description
Given that there are a sizeable number of files in the repository at this point, there are a few measures that can be taken up for code maintainability:
- Code restructuring: While we have a decent folder structure, I feel that further structure can be enforced (mainly within the
srcdirectory, for cleaner code segregation - Class/File renaming: Files have been using the a-b-c.jsx naming format, and certain functions and classes have names that are not informative enough. Shifting to a consistent camelcase format and making sure class names are informative would be imperative to solving this issue.
- Removing unused files: There seem to be a lot of abandoned auth workflows, and certain pieces of dead code lying around. Cleaning these up would also be very helpful.
- Conversion to functional components: A few components still use class-based structures, which can make the codebase harder to maintain and less consistent with modern React practices. Converting them to functional components would simplify state management, improve readability and help us use React hooks for cleaner logic separation.
- Documentation: A simple documentation about the website's features in the readme might help contributors correlate between the features and the underlying code.
- Code quality checks: Using tools such as Sonarqube to check code quality would be a good to have. This could be used by the devs on vscode, and integration into github's CI/CD pipeline could be looked into as well.
This can be a parent issue to discuss said matters, and since this cannot be resolved in 2-3 PRs, we can maintain this issue as a parent issue for further discussions, and create child issues that correspond to each of these larger issues.