Alan BuscagliaDescription
This repository hosts the UI component for Prowler, providing a user-friendly web interface to interact seamlessly with Prowler's features.
🚀 Production deployment
Docker deployment
Clone the repository
# HTTPS
git clone https://github.com/prowler-cloud/ui.git
# SSH
git clone git@github.com:prowler-cloud/ui.git
Build the Docker image
docker build -t prowler-cloud/ui . --target prod
Run the Docker container
docker run -p 3000:3000 prowler-cloud/ui
Local deployment
Clone the repository
# HTTPS
git clone https://github.com/prowler-cloud/ui.git
# SSH
git clone git@github.com:prowler-cloud/ui.git
Build the project
pnpm run build
Run the production server
pnpm start
🧪 Development deployment
Docker deployment
Clone the repository
# HTTPS
git clone https://github.com/prowler-cloud/ui.git
# SSH
git clone git@github.com:prowler-cloud/ui.git
Build the Docker image
docker build -t prowler-cloud/ui . --target dev
Run the Docker container
docker run -p 3000:3000 prowler-cloud/ui
Local deployment
Clone the repository
# HTTPS
git clone https://github.com/prowler-cloud/ui.git
# SSH
git clone git@github.com:prowler-cloud/ui.git
Install dependencies
pnpm install
Note: The pnpm install command will automatically configure prek Git hooks for code quality checks. If hooks are not installed, run from the repo root:
prek install
Run the development server
pnpm run dev
Technologies Used
Git Hooks & Code Review
This project uses Git hooks to maintain code quality. When you commit changes to TypeScript/JavaScript files, the pre-commit hook can optionally validate them against our coding standards using Claude Code.
Enabling Code Review
To enable automatic code review on commits, add this to your .env file in the project root:
CODE_REVIEW_ENABLED=true
When enabled, the hook will:
- ✅ Validate your staged changes against
AGENTS.mdstandards - ✅ Check for common issues (any types, incorrect imports, styling violations, etc.)
- ✅ Block commits that don't comply with the standards
- ✅ Provide helpful feedback on how to fix issues
Disabling Code Review
To disable code review (faster commits, useful for quick iterations):
CODE_REVIEW_ENABLED=false
Or remove the variable from your .env file.
Requirements
- Claude Code CLI installed and authenticated
.envfile in the project root withCODE_REVIEW_ENABLEDset
Troubleshooting
If hooks aren't running after commits, verify prek is installed and hooks are set up:
# Check prek is available
prek --version
# Re-install hooks if needed
prek install --overwrite