# Background

Melodiest is [Sinatra](http://www.sinatrarb.com/) application boilerplate. It provides generator and contains minimum configuration to develop application with Sinatra.
The reason why I create Melodiest is because I want to create many small web application based on sinatra with other third party ruby gems as foundation.
Originally, I wanted to name this project as Harmony or Melody, but because it was already taken I decided to name this project as Melodiest.

### Installation

```ruby
gem install melodiest
```

with Bundler, put this code in your Gemfile:

```ruby
gem 'melodiest'
```

### How to Use
generate app in current directory without database

```
melodiest -n my_app
```

generate app in target directory without database

```
melodiest -n my_app -t target/dir
```

generate app in current directory with database. `-d` option will generate app with `Sequel` orm and PostgreSQL adapter.

```
melodiest -n my_app -d
```

### Melodiest::Application
Because Melodiest is already required Sinatra, you don't have to require 'sinatra' anymore, just require 'melodiest'.

`Melodiest::Application` is subclass from `Sinatra::Application`.

```ruby
# my_app.rb

class App < Melodiest::Application
  cookie_secret 'this_is_secret_for_encrypted_cookie'
  ...
end
```

### Example Usage
This example assume that PostgreSQL is already running and desired database is already exist.
For complete example see [github.com/kuntoaji/todo_melodiest](https://github.com/kuntoaji/todo_melodiest)
  1. run `melodiest -n my_app -d`
  2. cd `my_app`
  3. run `bundle install`
  4. create `config/database.yml` and configure your database setting
  5. create file `db/migrations/001_create_artists.rb` and put the following code:
  
  ```ruby
  Sequel.migration do
    up do
      create_table(:artists) do
        primary_key :id
        String :name, :null=>false
      end
    end
  
    down do
      drop_table(:artists)
    end
  end
  ```
  
  6. run `rake db:migrate`
  7. create file `app/models/Artist.rb` and put the following code:
  
  ```ruby
  class Artist < Sequel::Model
  end
  ```
  
  8. create file `app/routes/artists.rb` and put the following code:
  
  ```ruby
  class MyApp
    get '/artists' do
      @artists = Artist.all
      erb :"artists/index"
    end
    
    post '/artists' do
      @artist = Artist.new
      @artist.name = params[:name]
      @artist.save
      
      redirect '/artists'
    end
  end
  ```
  
  9. create file `app/views/artists/index.erb` and put the following code:
  
  ```erb
  <h1>List of Artist</h1>
  <ul>
    <% @artists.each do |artist| %>
      <li><%= artist.name %></li>
    <% end %>
  </ul>
  
  <form action="/artists" method="post">
    <%= Rack::Csrf.tag(env) %>
    <input type="text" name="name" />
    <button>Submit</button>
  </form>
  ```
  
  10. run the server `bundle exec thin start`
  11. open url `localhost:3000/artists`

### List of Ruby Gems

  * sinatra (required by default)
  * sinatra-contrib (required by default)
  * encrypted_cookie (required by default)
  * `Sinatra::Reloader` in development environment only
  * thin
  * `Rack::Session::EncryptedCookie`
  * `Rack::Csrf`
  * sequel
  * sequel_pg as PostgreSQL adapter
  * sinatra-asset-pipeline
  * uglifier
  * tux for console
  * `Sinatra::Cache` in production environment only