https://github.com/asafkorem/kaizen
Smart hot-spots detection in codebases
https://github.com/asafkorem/kaizen
Last synced: 12 months ago
JSON representation
Smart hot-spots detection in codebases
- Host: GitHub
- URL: https://github.com/asafkorem/kaizen
- Owner: asafkorem
- License: mit
- Created: 2024-08-10T12:14:57.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-21T10:59:36.000Z (almost 2 years ago)
- Last Synced: 2025-06-29T08:17:13.377Z (12 months ago)
- Language: JavaScript
- Homepage: https://asafkorem.github.io/Kaizen/
- Size: 93.3 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Code Kaizen
## Smart hot-spots detection
Kaizen (改善, "continuous improvement" in Japanese) is a powerful code analysis tool designed to identify and visualize hot-spots in your codebase.
By leveraging Git history and static analysis, Kaizen provides actionable insights to guide your refactoring efforts and improve code quality.
## Demo
You can check out the live demo at [https://asafkorem.github.io/Kaizen/](https://asafkorem.github.io/Kaizen/).
## Usage
### Project Requirements
Kaizen works only with Node.js projects that use Git for version control.
### Running Kaizen
You can simply run Code Kaizen using `npx` without installing it.
```shell
npx code-kaizen
```
You can configure the path to the repository and the path to the directory where you want to store the artifacts.
```
npx code-kaizen
```
- Default path to the repository is the **current working directory**.
- Default output is **'kaizen' directory** in the current working directory.
### Installation
If you don't want to use `npx`, you can install Kaizen globally using npm, yarn, or Homebrew.
#### Using npm
```shell
npm install -g code-kaizen
```
#### Using yarn
```shell
yarn global add code-kaizen
```
#### Using Homebrew
```shell
brew tap asafkorem/kaizen
brew install asafkorem/kaizen/code-kaizen
```
## Contributing
I like all contributions, big or small.
If you have a feature request, bug report, or patch, feel free to open an issue or a pull request.
You can also find me on [Kaizen's server on Discord](https://discord.gg/EWfmnnfb5T) or at `asafk@wix.com`.