github.com/GrottoPress/penny
master / published Aug 9, 2026 / repository
Get up and running with Lucky framework and Shield
Penny
Penny is a Lucky application scaffold that gets you up and running with Shield.
Setting up
- Clone this repository:
git clone https://github.com/GrottoPress/penny.git my-app - Change into the app directory:
cd my-app - Install dependencies:
shards install - Copy
sample.env.ymlto.env.yml - Edit settings in
.env.yml - Run
script/setup.cr - Run
lucky devto start the app
Development
Run tests with crystal spec.
Resources
API
- Api
- App
- AppDatabase
- AppServer
- BaseComponent
- BaseEmail
- BaseHandler
- BaseModel
- BearerLogin
- BearerLoginNotificationEmail
- BearerLoginQueryFilter
- BearerLoginQueryLoader
- BearerLoginResponse
- BearerLoginResponseFilter
- BearerLoginSerializer
- BearerLogins
- BrowserAction
- CorsHandler
- CurrentLogin
- CurrentUser
- DeleteBearerLoginsJob
- DeleteEmailConfirmationsJob
- DeleteLoginsJob
- DeletePasswordResetsJob
- EmailConfirmation
- EmailConfirmationQueryFilter
- EmailConfirmationQueryLoader
- EmailConfirmationRequestEmail
- EmailConfirmationResponse
- EmailConfirmationResponseFilter
- EmailConfirmationSerializer
- EmailConfirmations
- Errors
- FailureSerializer
- GuestPasswordResetRequestEmail
- Health
- Home
- Login
- LoginNotificationEmail
- LoginQueryFilter
- LoginQueryLoader
- LoginResponse
- LoginResponseFilter
- LoginSerializer
- Logins
- Menus
- Mixins
- PasswordChangeNotificationEmail
- PasswordReset
- PasswordResetQueryFilter
- PasswordResetQueryLoader
- PasswordResetRequestEmail
- PasswordResetResponse
- PasswordResetResponseFilter
- PasswordResetSerializer
- PasswordResets
- PrivateApi
This action accepts only
Logintokens for authentication purposes. - PublicApi
This action accepts both
LoginandBearerLogintokens for delegated authorization purposes. - QueryPattern
This checks if any field in a collection of fields matches a pattern.
- RegisterCurrentUser
- RegisterUser
- RequestIdHeader
- Shared
- UpdateCurrentUser
- UpdateUser
- User
- UserEmailConfirmationRequestEmail
- UserLevel
- UserQuery
- UserQueryFilter
- UserResponse
- UserResponseFilter
- UserSerializer
- UserSettings
- UserWelcomeEmail
- Users
- WelcomeEmail