Skip to content
A bare-bones blogging application
Crystal JavaScript Shell CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
config
db/migrations
public
script
spec
src
tasks
.babelrc
.crystal-version
.editorconfig
.gitignore
.travis.yml
LICENSE.txt
Procfile
Procfile.dev
README.md
bs-config.js
package.json
shard.lock
shard.yml
tasks.cr
webpack.mix.js
yarn.lock

README.md

fortunate

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

Installation

  1. Follow Lucky's installation instructions to get the required depencies.
  2. Create a PostgreSQL database fortunate_production.
  3. Clone the git repo from https://github.com/oneiros/fortunate
  4. Run yarn install and shards install
  5. 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).
  6. Compile assets with yarn prod
  7. 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.

Configuration

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

Development

  1. Install required dependencies
  2. Clone the git repo from https://github.com/oneiros/fortunate
  3. Run script/setup
  4. Run lucky dev to start the app

You can learn about Lucky from the Lucky Guides.

Contributing

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

License

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

You can’t perform that action at this time.