Skip to content

README.md

Latest commit

 

History

History
40 lines (26 loc) · 1.36 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.36 KB

BenchMate

BenchMate is a Frappe app designed to make ERPNext bench and site management effortless. It provides a user-friendly interface for automating tasks such as bench creation, site setup, app installation, backups, and restores—all directly within your Frappe environment. With BenchMate, you can streamline administration and maintenance for your ERPNext projects, boost productivity, and ensure consistency without relying on complex commands or scripts.

Installation

You can install this app using the bench CLI:

cd $PATH_TO_YOUR_BENCH
bench get-app $URL_OF_THIS_REPO --branch develop
bench install-app benchmate

Contributing

This app uses pre-commit for code formatting and linting. Please install pre-commit and enable it for this repository:

cd apps/benchmate
pre-commit install

Pre-commit is configured to use the following tools for checking and formatting your code:

  • ruff
  • eslint
  • prettier
  • pyupgrade

CI

This app can use GitHub Actions for CI. The following workflows are configured:

  • CI: Installs this app and runs unit tests on every push to develop branch.
  • Linters: Runs Frappe Semgrep Rules and pip-audit on every pull request.

License

agpl-3.0