penny

Installation

# Add this to your shard.yml
dependencies:
  penny:
    github: GrottoPress/penny
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal

~> 1.20

Authors

GrottoPress <info@grottopress.com>, N Atta Kusi Adusei

Target

• cli from tasks.cr

Dependencies

Runtime Dependencies

• mel~> 1.2github: GrottoPress/mel
• envy~> 1.0github: GrottoPress/envy
• halo~> 0.3.0github: GrottoPress/halo
• i18n~> 0.2.1github: crystal-i18n/i18n
• avram~> 1.5github: luckyframework/avram
• fella~> 0.3.0github: GrottoPress/fella
• lucky~> 1.5github: luckyframework/lucky
• carbon~> 0.6.0github: luckyframework/carbon
• shield~> 1.7github: GrottoPress/shield
• defense*github: defense-cr/defense, commit: 52e6430dc1c772497650a725b3bb4e568db02b2f
• unslash~> 1.0github: GrottoPress/unslash
• lucky_env~> 0.3.0github: luckyframework/lucky_env

Development Dependencies

• ameba~> 1.6.0github: crystal-ameba/amebadev
• lucky_flow~> 0.10.0github: luckyframework/lucky_flowdev

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.cr`
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)