Updated readme and makefile.

This commit is contained in:
mikestefanello 2025-04-21 21:47:51 -04:00
parent a418003eaf
commit b6d2b01c9b
2 changed files with 6 additions and 5 deletions

View file

@ -15,12 +15,12 @@ ent-gen: ## Generate Ent code
go generate ./ent go generate ./ent
.PHONY: ent-new .PHONY: ent-new
ent-new: ## Create a new Ent entity (ie, make ent-new NAME=MyEntity) ent-new: ## Create a new Ent entity (ie, make ent-new name=MyEntity)
go run entgo.io/ent/cmd/ent new $(NAME) go run entgo.io/ent/cmd/ent new $(name)
.PHONY: admin .PHONY: admin
admin: ## Create a new admin user (ie, make admin EMAIL=myemail@web.com) admin: ## Create a new admin user (ie, make admin email=myemail@web.com)
go run cmd/admin/main.go --email=$(EMAIL) go run cmd/admin/main.go --email=$(email)
.PHONY: run .PHONY: run
run: ## Run the application run: ## Run the application

View file

@ -171,7 +171,7 @@ cd pagoda
### Create an admin account ### Create an admin account
In order to access the [admin panel](#admin-panel), you must log in with an admin user and in order to create your first admin user account, you must use the command-line. Execute `make admin EMAIL=your@email.com` from the root of the codebase, and an admin account will be generated using that email address. The console will print the randomly-generated password for the account. In order to access the [admin panel](#admin-panel), you must log in with an admin user and in order to create your first admin user account, you must use the command-line. Execute `make admin email=your@email.com` from the root of the codebase, and an admin account will be generated using that email address. The console will print the randomly-generated password for the account.
Once you have one admin account, you can use that account to manage other users and admins from within the UI. Once you have one admin account, you can use that account to manage other users and admins from within the UI.
@ -421,6 +421,7 @@ Since the generated code is completely dynamic, all entity functionality related
- Field validation must be defined within each entity field (ie, validating an email address in a _string_ field). - Field validation must be defined within each entity field (ie, validating an email address in a _string_ field).
- Pre-processing must be defined within entity hooks (ie, hashing the user's password). - Pre-processing must be defined within entity hooks (ie, hashing the user's password).
- _Sensitive_ fields will be omitted from the UI, and only modified if a value is provided during creation or editing. - _Sensitive_ fields will be omitted from the UI, and only modified if a value is provided during creation or editing.
- _Edges_ must be bound to an [edge field](https://entgo.io/docs/schema-edges#edge-field) if you want them visible and editable.
### Roadmap ### Roadmap