Software practices metrics tool is an open-source project aimed at assisting teams in measuring and enhancing their adherence to industry-recommended software practices. Follows client-server architecture, the tool harnesses React for the client-side interface and Express Node.js for the server. It offers comprehensive insights into industry recommended software practices like code review and trunk-based development, empowering teams to elevate the quality and efficiency of their projects. Presently, it supports projects housed in Azure DevOps repositories.
For more information about the client-side implementation, check out the Client README.
For more information about the server-side implementation, please refer to the Server README.
Software practices metrics tool is designed to provide automated analytics on software practices like code review metrics & trunk-based development. These analytics & insights derived will help developers & teams to continuously improve their software delivery efficiency & measure their performance.
- Code review metrics: Gain insights into the effectiveness of code reviews, including metrics on review times, feedback cycles, and reviewer participation.
- Trunk based development metrics: Monitor the health of your trunk-based development approach, with data on branch life cycles, merge frequency, and adherence to naming conventions.
To start using the Software Practices Metrics Tool, follow these simple steps:
To get started, clone the project repository to your local machine. Open your terminal and execute the following command:
git clone https://github.com/solitontech/software-practices-metrics-tool.gitBefore proceeding, make sure you have Node.js and npm installed on your system. We recommend using Node.js version used here for compatibility. You can download and install it from the official Node.js website.
Additionally, we recommend to use Visual Studio Code for this codebase. If you haven't already installed it, you can download it from the official VS Code website.
Once you have Visual Studio Code installed, you can proceed to install the following extensions:
- Code Spell Checker: Helps to catch spelling errors in your code and comments.
- Error Lens: Highlights and annotates errors and warnings directly on your code.
- ESLint: Provides linting for JavaScript and TypeScript files to maintain code quality.
- Markdownlint: Ensures proper formatting and adherence to Markdown standards in your Markdown files.
- Prettier - Code Formatter: Automatically formats your code to maintain consistent styling.
You can install these extensions directly from the Visual Studio Code marketplace. Simply search for each extension by name and click the "Install" button.
Once you have Node.js installed and the recommended extensions set up in Visual Studio Code, you're ready to proceed with configuring the project environment.
cd client
npm installcd server
npm installRefer Configure Server Configuration File to configure server config file.
Launch the server and client of the tool to start analyzing your project's software practices metrics.
# Start the server
$ cd server
$ npm run start:dev
# Start the client
$ cd ../client
$ npm run start:devOnce both the server and client are running, you can access the application by navigating to http://localhost:5173 in your web browser.
Keep in mind that if there are any validation errors in the server configuration file (server-config.json), the server won't run properly. Ensure that you have correctly configured the necessary settings such as the target branch, organization, project name, repository ID, and authentication token before starting the server.
We welcome contributions from the community to enhance and expand the functionality of the Software Practices Metrics Tool. Please refer to the Contributing Guidelines for instructions on how to get involved.
The Software Practices Metrics Tool is distributed under the GNU General Public License (GPL) version 3.0. Feel free to use, modify, and distribute the tool in accordance with the terms of this license.
For any questions, feedback, or collaboration opportunities, please reach out to us at techops@solitontech.com.