fortunate

fortunate is a bare-bones, simple blog app. It is written using Lucky.

Installation

Follow Lucky's installation instructions to get the required depencies.
Create a PostgreSQL database fortunate_production.
Clone the git repo from https://github.com/oneiros/fortunate
Run yarn install and shards install
Migrate the database with crystal run tasks.cr -- db.migrate. Optionally run crystal run tasks.cr -- db.create_sample_seeds to create sample data including an initial user (admin@example.com:password).
Compile assets with yarn prod
Compile fortunate with crystal build --release src/start_server.cr

See Lucky's deployment guides for some additional / alternative ideas to get up and running.

fortunate can be configured using environment variables.

Variable name	Default Value	Description
LUCKY_ENV	development	Lucky's environment. Set this to `production` for live installations. The default is fine if you want to improve the code.
DATABASE_URL	"postgres:///fortunate_<environment>"	The PostgreSQL-URL used to connect to your database
SECRET_KEY_BASE	none	Set this to a random string. You can use `crystal run tasks.cr -- gen.secret_key` to generate one.
APP_DOMAIN	none	Set this to the base url of your domain, e.g. `https://blog.example.com`
FORTUNATE_SITE_NAME	"My Blog"	The name of your blog

You can learn about Lucky from the Lucky Guides.

Bug reports and pull requests are welcome on GitHub at https://github.com/oneiros/fortunate.

The project is available as open source under the terms of the MIT License. See LICENSE.txt.

Repository

fortunate

Owner

Statistic

License

MIT License

Links

Synced at

Sun, 17 Nov 2024 09:45:33 GMT

Languages