https://github.com/grottopress/penny
Get up and running with Lucky framework and Shield
https://github.com/grottopress/penny
crystal lucky-framework
Last synced: 11 months ago
JSON representation
Get up and running with Lucky framework and Shield
- Host: GitHub
- URL: https://github.com/grottopress/penny
- Owner: GrottoPress
- License: mit
- Created: 2020-11-12T14:30:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-19T10:43:19.000Z (11 months ago)
- Last Synced: 2025-04-19T16:18:16.226Z (11 months ago)
- Topics: crystal, lucky-framework
- Language: Crystal
- Homepage:
- Size: 4.35 MB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Penny
*Penny* is a [*Lucky*](https://luckyframework.org) application scaffold that gets you up and running with [*Shield*](https://github.com/grottopress/shield).
### Setting up
1. Clone this repository: `git clone https://github.com/GrottoPress/penny.git my-app`
1. Change into the app directory: `cd my-app`
1. Install dependencies: `shards install`
1. Copy `sample.env.yml` to `.env.yml`
1. Edit settings in `.env.yml`
1. Run `script/setup`
1. Run `lucky dev` to start the app
### Development
Run tests with `crystal spec`.
### Resources
- [Crystal](https://crystal-lang.org)
- [Lucky](https://luckyframework.org)
- [Shield](https://github.com/grottopress/shield)
- [Defense](https://github.com/defense-cr/defense)
- [Mel](https://github.com/grottoPress/mel)
- [Fella](https://github.com/grottopress/fella)