commit e89baa7a979c05f05ab831f036cddc38afabf848 Author: Scott Korvek Date: Mon Nov 10 15:15:34 2025 +0000 first commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..b78fa58 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +### Event Directory + +Directory of local events for member businesses + +### Installation + +You can install this app using the [bench](https://github.com/frappe/bench) CLI: + +```bash +cd $PATH_TO_YOUR_BENCH +bench get-app $URL_OF_THIS_REPO --branch develop +bench install-app event_directory +``` + +### Contributing + +This app uses `pre-commit` for code formatting and linting. Please [install pre-commit](https://pre-commit.com/#installation) and enable it for this repository: + +```bash +cd apps/event_directory +pre-commit install +``` + +Pre-commit is configured to use the following tools for checking and formatting your code: + +- ruff +- eslint +- prettier +- pyupgrade + +### License + +mit