meichthys/church
1
0
Fork 0
mirror of https://github.com/meichthys/church.git synced 2026-02-09 18:33:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme with permissions notes

Browse Source
This commit is contained in:
meichthys 2025-09-22 03:53:54 +00:00
parent c42b6891fe
commit 7916a8996a
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -67,6 +67,8 @@ bench install-app church
After the above installation you should be able to access the web interface using the URL you defined in the `bench create` command above. You should see the `Church` app installed when you view `Help > About`.
Before you start using the app, it is a good idea to setup a new `User` in the system with the `Church Admin` Role Profile and `Church Admin` Module Profile. This user will be able to manage all aspects of the church (the `Administrator` user should be reserved for system wide maintenance or troubleshooting). Additionally, if you want to delegate some responsibilities to other people, you can create additional `User`s with the `Church User` Role Profile and `Church User` Module Profiles. Thise types of users will be able to read and update most information, but not critical information. To see a list of permissions you can open the `Role Permissions Manager` and select the `Church Admin` or `Church User` roles to see what permissions these users roles have.
## 🗺️ Feature Roadmap
Hopefully this roadmap will help avoid too much scope creep and provide a sense of where this project is headed. The items below are listed in order of current priority.
@ -98,6 +100,16 @@ Contributions are very welcome! If you plan any large contributions, please let
- Doctype Naming: I've generally been using a single fieldname for the doctype names when the records in the doctype have low chance of clashing. If there is a higher chance of clashing, I've been using multiple fields in the name along with a `{##}` auto increment. The number of digits in the auto-increment are just sane values that should never be exceeded. I then specify the Title Field in the View Settings, and check the `Show Title in LInk Fields` option. This mostly hides the autonumber name from the user and lets the user only see the not-so-confusing name specified in the `Title Field` (sometimes I create a custom field to concatenate values - since the `Title Field` cannot take multiple fields at once afaik.)
## Steps for adding a new doctype:
- Make sure the doctype name is pre-pended with `Church `
- Add a doctype description on the settings tab
- Add fields for the doctype (if necessary add field descriptions).
- Add permissions for the new doctype to the `Church User` and `Church Admin` roles.
- After adding permisssions, export the permissions by going to the DocType and chosing ... > Customize > Action > Export Customizations. Select the `Church` module and check both the 'Sync on Migrate' and `Export Custom Permissions` options and lick 'Submit'.
- Add the doctype to the relevant workspace.
- If necessary, add an onboarding step & form tour to explain specific fields.
- If any default records for this doctype should be shipped with the app, add fixtures for them in `hooks.py`.
## Pre-Commit
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: