BrainSprout Skeleton
A quick and dirty app skeleton for the Athena Framework, which includes:
- A flexible directory structure
- Pre-configured binary entrypoints for HTTP and CLI contexts
- Development code-quality/testing dependencies + CI
- Minimal runnable Athena Framework application
- Dotenv for local development
- Database integration via Crecto
- Carbon for sending emails
Getting Started
- Generate a new repository using this template.
- Run
shards install
- Rename
MyApp
module withinsrc/main.cr
to your desired name - Rename
skeleton
shard name withinshard.yml
to your desired name - Update
./LICENSE
with your desired name/email - Start creating your application!
Entrypoints
The template repository includes build targets for both the HTTP and CLI contexts.
Or in other words, ./bin/console
and ./bin/server
binaries are created by running shards build
.
This makes it easy to deploy both parts of the application independently from one another.
TIP: The
shards run
command may be used during development to interact with each target. E.g.shards run server
to start the server andshards run console -- debug:router
to execute console commands.