feat: Add Makefile to organize project commands and enhance usability
This commit is contained in:
40
README.md
40
README.md
@@ -140,6 +140,46 @@ docker compose up -d couchdb
|
||||
VITE_COUCHDB_URL=http://localhost:5984 bun run dev
|
||||
```
|
||||
|
||||
### **Makefile Commands**
|
||||
|
||||
For convenience, you can use the included Makefile which wraps all package.json scripts with organized categories:
|
||||
|
||||
```bash
|
||||
# Show all available commands
|
||||
make help
|
||||
|
||||
# Quick development commands
|
||||
make start # Start development server
|
||||
make build # Build the application
|
||||
make test # Run unit tests
|
||||
|
||||
# Testing commands
|
||||
make test-all # Run all tests (unit + integration + e2e)
|
||||
make test-e2e # Run end-to-end tests
|
||||
make test-coverage # Run tests with coverage
|
||||
|
||||
# Code quality
|
||||
make lint # Run all linting checks
|
||||
make pre-commit # Run pre-commit checks
|
||||
make full-check # Run complete code quality check
|
||||
|
||||
# Kubernetes deployment
|
||||
make k8s-deploy # Deploy to Kubernetes
|
||||
make k8s-undeploy # Remove from Kubernetes
|
||||
make k8s-deploy-dry # Dry run deployment
|
||||
|
||||
# Docker operations
|
||||
make docker-build # Build Docker images
|
||||
make docker-setup # Setup Docker buildx
|
||||
|
||||
# Quick combinations
|
||||
make build-and-test # Build and test
|
||||
make quick-deploy # Build and deploy to K8s
|
||||
make reset # Clean and reinstall
|
||||
```
|
||||
|
||||
All Makefile targets are organized into logical categories (Development, Testing, Code Quality, Kubernetes, Docker, etc.) and provide colored output for better visibility.
|
||||
|
||||
### **Code Quality**
|
||||
|
||||
This project includes comprehensive code quality tools and pre-commit hooks. See [`docs/development/CODE_QUALITY.md`](docs/development/CODE_QUALITY.md) for detailed documentation.
|
||||
|
||||
Reference in New Issue
Block a user