Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simonneutert/sinatras-skeleton

Basic Sinatra Skeleton MVC CRUD App with Sprockets, Warden, ActiveRecord and PostgresQL
https://github.com/simonneutert/sinatras-skeleton

activerecord boilerplate boilerplate-application coffeescript crud-application haml heroku heroku-ready mvc postgres postgresql ruby sass sinatra sinatra-skeleton sprockets template turbolinks warden

Last synced: about 2 months ago
JSON representation

Basic Sinatra Skeleton MVC CRUD App with Sprockets, Warden, ActiveRecord and PostgresQL

Host: GitHub
URL: https://github.com/simonneutert/sinatras-skeleton
Owner: simonneutert
License: mit
Created: 2017-03-04T10:32:57.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2024-06-29T09:29:14.000Z (3 months ago)
Last Synced: 2024-07-05T10:44:38.858Z (3 months ago)
Topics: activerecord, boilerplate, boilerplate-application, coffeescript, crud-application, haml, heroku, heroku-ready, mvc, postgres, postgresql, ruby, sass, sinatra, sinatra-skeleton, sprockets, template, turbolinks, warden
Language: Ruby
Homepage:
Size: 411 KB
Stars: 16
Watchers: 4
Forks: 5
Open Issues: 6
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: License

Awesome Lists containing this project

README

# Basic Sinatra ~v3~ v4 🥳 App with Sprockets, Warden, ActiveRecord and Postgres

Take this as a working example and as an inspiration. Pull Requests are welcome 🙏

[![ruby](https://github.com/simonneutert/sinatras-skeleton/actions/workflows/ruby.yml/badge.svg)](https://github.com/simonneutert/sinatras-skeleton/actions/workflows/ruby.yml)

### Have you tried Roda?

think sinatra is nice? Don't forget to [give Roda a chance](https://github.com/jeremyevans/roda-sequel-stack)!
browse through my repos 😉😇

---

## What this Project aims to be

**This repository aims to be a boilerplate for a modular and modern (v2) Sinatra app.**

there used to be a demo on heroku, but heroku is no more 🪦

*please check out the [credits](#credits) section! Without the community, this never would have been possible. Thank you.*

* [Why?](#why)
* [What is in?](#what)
* [Get started](#start)
* [Credits](#credits)

*Feel free to contribute, add more features, strip features or simply improve existing code* - __pull requests welcome__ :smile:

## Why not Rails?

Sinatra is a ruby/rack framework, that can be used as an alternative where Rails would simply be an overkill.

I started working my way through the sinatra docs, aiming for a setup that can easily be modeled to a basic use case.

---

> Have you tried Roda, Sequel and Rodauth?

Yes! And I totally use that setup whenever possible (November 2021) and you should try at least roda as a POC 😎 I am 100 % serious! There's nothing wrong with sinatra, but roda kills it. The journey will undoubtedly make you a better (ruby) programmer.

## What is in?

I want this Sinatra boilerplate app to:

* work with Bundler
* use ORM is ActiveRecord
* have an MVC-like structure
* support Sass/Scss and CoffeeScript
* party with [jQuery](http://jquery.com) and [Turbolinks](https://github.com/turbolinks/turbolinks)! Yes, Turbolinks.
* rolls with a very basic bcrypt/warden based Authentication System
* use PostgresQL as Database
* run on heroku (don't forget: `$ heroku config:add APP_ENV=production`)

## Get started
You need **Ruby (>= 3.2)** and **Bundler** (of course).

* `$ git clone`
* `$ bundle install`
* edit __config/database.yml__
* `$ rake db:setup`
* `$ bundle exec puma` or `rerun rackup` ([rerun](https://github.com/alexch/rerun) gem - _not included by default!_)
* visit `localhost:9292` in your browser
* edit titles in __views/layout.erb__ and __views/nav.erb__
* check/set timezone __config/timezone.rb__

### now what?
* read the credits
* read the code
* run the code, see what it does
* delete what you don't need and built from there, should a barebone branch be offered? What do you think? :grin:

Most code is commented, so you'll learn what it does.

### What needs to be done
* enable flash messages, especially for validation feedback

## Contribute
* Send in pull requests, improve this project with features or **simply by adding/improving comments** :grin:
* Be nice, make public forks
* What did you use this app for? Please, let me know! Share your projects.

## Credits / Blood, Sweat & Tears
:heart: :sweat: :sob:

**Contributors to this project**

https://github.com/simonneutert/sinatras-skeleton/graphs/contributors

thank you for open sourcing, writing documentation, blogging, answering and giving a hand on stackoverflow :thumbsup:

**Warden**

[sklises repo](https://github.com/sklise/sinatra-warden-example)

[Steve Klise Blog post](https://sklise.com/2013/03/08/sinatra-warden-auth/)

[Coderwall on Sinatra + Warden](https://coderwall.com/p/ellbgw/sinatra-authentication-with-warden)

[What Ches wrote up](https://gist.github.com/ches/243611)

[What Mike Ebert wrote](http://mikeebert.tumblr.com/post/27097231613/wiring-up-warden-sinatra)

**ActiveRecord + PostgresQL**

[mherman](http://mherman.org/blog/2013/06/08/designing-with-class-sinatra-plus-postgresql-plus-heroku/#.WKrnsxiX_-k)

[samuelstern](https://samuelstern.wordpress.com/2012/11/28/making-a-simple-database-driven-website-with-sinatra-and-heroku/)

**BCrypt**

[Kieran's Answer on StackOverflow](http://stackoverflow.com/questions/39525723/bcrypterrorsinvalidhash-error-in-rails/39526561#39526561)

[BCrypt Gem](https://github.com/codahale/bcrypt-ruby#how-to-use-bcrypt-ruby-in-general)

**Sprockets**

[Sinatra Recipe for Sprockets](http://recipes.sinatrarb.com/p/asset_management/sprockets)

**Official Sinatra Docs**

[Sinatra Intro](http://www.sinatrarb.com/intro.html)

[Sinatra recipes](http://recipes.sinatrarb.com/)