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

1. Generate a new repository using this template.
2. Run shards install
3. Rename MyApp module within src/main.cr to your desired name
4. Rename skeleton shard name within shard.yml to your desired name
5. Update ./LICENSE with your desired name/email
6. 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 and shards run console -- debug:router to execute console commands.