Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kuntoaji/sinator
Sinatra application generator
https://github.com/kuntoaji/sinator
api application-boilerplate boilerplate database gem gems generator generators puma ruby rubygems sequel sinatra web web-application
Last synced: about 2 months ago
JSON representation
Sinatra application generator
- Host: GitHub
- URL: https://github.com/kuntoaji/sinator
- Owner: kuntoaji
- License: mit
- Created: 2014-12-20T09:22:56.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-05-14T15:33:07.000Z (over 2 years ago)
- Last Synced: 2024-07-17T19:15:18.740Z (2 months ago)
- Topics: api, application-boilerplate, boilerplate, database, gem, gems, generator, generators, puma, ruby, rubygems, sequel, sinatra, web, web-application
- Language: Ruby
- Homepage:
- Size: 195 KB
- Stars: 21
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/sinator)
[](https://codeclimate.com/github/kuntoaji/sinator/maintainability)
[](https://codeclimate.com/github/kuntoaji/sinator/test_coverage)
# Background
Sinator is [Sinatra](http://www.sinatrarb.com/) application generator. It will generate Sinatra application with minimum configuration.
The reasons behind this project because I want to create many small web application based on sinatra with other third party ruby gems as foundation.
# Features
* Generate Sinatra based web application without database
* Generate Sinatra based web application with PostgreSQL database configuration and Sequel as ORM
* Rake task for assets precompile and assets clean
### Installation
```ruby
gem install sinator
```
with Bundler, put this code in your Gemfile:
```ruby
gem 'sinator'
```
### How to Use
Generate app in current directory without database.
```
sinator -n my_app
```
Generate app in target directory without database.
```
sinator -n my_app -t target/dir
```
Generate app in current directory with database. `-d` option will generate app with `Sequel` ORM and PostgreSQL adapter.
```
sinator -n my_app -d
```
Run web server on localhost.
```
bundle exec puma
```
Run application console / interactive mode / IRB.
```
bundle exec tux
```
### Example Usage
This example assume that PostgreSQL is already running.
See [github.com/kuntoaji/todo_sinator](https://github.com/kuntoaji/todo_sinator) for Todo Application generated with Sinator.
1. run `sinator -n my_app -d`
2. cd `my_app`
3. run `bundle install`
4. configure your database setting in `config/database.yml`
5. create database with `createdb my_app_development`.
6. 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
```
7. run `rake db:migrate`
8. create file `app/models/Artist.rb` and put the following code:
```ruby
class Artist < Sequel::Model
end
```
9. 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
```
10. create file `app/views/artists/index.erb` and put the following code:
```erb
List of Artist
- <%= artist.name %>
<% @artists.each do |artist| %>
<% end %>
<%= Rack::Csrf.tag(env) %>
Submit
```
11. run the server `bundle exec puma`
12. open url `localhost:9292/artists`
13. Enjoy! :)