CodeInspector v1.0.0 Release

CodeInspector

🔍 A software quality analysis tool based on hotspot prioritization and commits 🛠️

Made with:

CodeInspector v1.0.0 Release

I am excited to announce the first release of CodeInspector, a software quality analysis tool based on hotspot prioritization and commits, as part of my Bachelor Thesis.

Key Features:

• Full-stack application: CodeInspector is a full-stack application that provides comprehensive software quality analysis.
• Hotspot Prioritization: It identifies and prioritizes hotspots in your codebase for quality improvement.
• Commit Analysis: It provides insights on the commits, helping you understand the evolution of your codebase.
• Complexity Analysis: It analyzes the complexity of your code and provides recommendations for improvement.
• File Churn Analysis: It provides insights on modified files and file churn, helping you focus your quality improvement efforts where they matter most.

To use CodeInspector, simply provide a repository URL and let the tool generate insights on your codebase. I look forward to your feedback and suggestions as we continue to improve CodeInspector.

Installation

1. Clone the Repository
   You can do this by running the following command in your terminal:

git clone https://github.com/ArchontisKostis/CodeInspector.git

2. Navigate to the Project Directory
   Once you have cloned the repository, navigate into the project directory:

cd CodeInspector

3. Run Docker Compose
   Now you can start the CodeInspector application using Docker Compose. Run the following command in your terminal:

docker-compose up

Bug Reporting

If you encounter any problems or bugs while using CodeInspector, or if you have suggestions for improvements, we encourage you to report these on our GitHub page. Here’s how you can do it:

1. Navigate to the CodeInspector GitHub repository.
2. Click on the “Issues” tab.
3. Click on the “New issue” button.
4. Provide a title and a detailed description of the issue or suggestion. If it’s a bug, include steps to reproduce it, and any error messages or screenshots.
5. When you’re done, click “Submit new issue”.

Your feedback is invaluable in helping us improve CodeInspector. Thank you for your contribution!

🎓 Credits

CodeInspector was created by me (Archontis E. Kostis), as part of my bachelor thesis, with the support and guidance of Mr. Alexander Hatzigeorgiou, Vice Rector of Extroversion and International Relations of University of Macedonia and professor at the Department of Applied Informatics. The project was inspired by a shared passion for improving software quality through data-driven and mining software repositories analysis. The development of this tool would not have been possible without the open-source contributions of the FastAPI, Python, React and PyDriller communities. We are grateful for their efforts in making high-quality software accessible to everyone.