Skip to content
This repository has been archived by the owner on Oct 18, 2022. It is now read-only.

eucalypt-framework/eucalypt

Repository files navigation



Micro-framework, application generator and CLI wrapped around the Sinatra DSL.

Ruby Version Gem Build Status License Documentation

Installation

To install the CLI, run:

$ gem install eucalypt

Usage

Running the top-level eucalypt command displays information about initializing a new application:

Initialize a new application with:

$ eucalypt init my-new-app

Once the setup is complete, make sure the required gems have been installed (without any errors).

Commands

Move into your new application's directory and run the top-level eucalypt command to display a list of all available commands:

Documentation

Full documentation can be found in the form of a GitBook, here.

Directory structure

Click here to see the structure of a generated application.

.
├── Gemfile
├── Gemfile.lock
├── Gumfile
├── Procfile
├── Rakefile
├── app
│   ├── assets
│   │   ├── fonts
│   │   ├── images
│   │   ├── scripts
│   │   │   └── application.js
│   │   └── stylesheets
│   │       └── application.scss
│   ├── controllers
│   ├── helpers
│   ├── models
│   ├── static
│   │   └── public
│   └── views
│       ├── index.erb
│       ├── layouts
│       │   └── main.erb
│       └── partials
├── app.rb
├── config
│   ├── assets.rb
│   ├── database.yml
│   ├── initializers
│   └── logging.rb
├── config.ru
├── logs
└── spec
    ├── controllers
    ├── helpers
    ├── models
    └── spec_helper.rb

Features

Type Feature
Core/DSL Sinatra
CLI builder Thor
Web server Thin
ORM ActiveRecord
ORDBMS PostgreSQL + SQLite3
Asset pipeline Sprockets
Templating engine ERB
Markdown processor RDiscount
Front matter parsing FrontMatterParser
HTML helpers Hanami
CSS preprocessing SCSS
JS compressing Uglifier
Logging Lumberjack
Specs RSpec + Rack-Test + Shoulda-Matchers

Contributors

Edwin Onuonga
Edwin Onuonga

✉️ 🌍
Ahmad
Mo Tolba

✉️ 🌍

Eucalypt © 2018-2020, Edwin Onuonga - Released under the MIT License.
Authored and maintained by Edwin Onuonga.

eonu.net  ·  GitHub: @eonu  ·  Email: ed@eonu.net