https://github.com/crowdhailer/iridescence
example application with scorched
https://github.com/crowdhailer/iridescence
Last synced: 3 months ago
JSON representation
example application with scorched
- Host: GitHub
- URL: https://github.com/crowdhailer/iridescence
- Owner: CrowdHailer
- Created: 2015-03-01T21:33:04.000Z (almost 11 years ago)
- Default Branch: setup
- Last Pushed: 2015-03-29T14:41:05.000Z (almost 11 years ago)
- Last Synced: 2025-04-02T05:17:08.405Z (9 months ago)
- Language: Ruby
- Size: 203 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Iridescence
===========
#### Example web application built with Scorched
Visit setup branch to take project agnostic setup
- Includes Procfile for thin on Heroku
- Includes contstraints validations table on first migration
Also used as the development enviroment for several Gems to encourage Domain Driven Design(DDD) in a rapid start up enviroment.
## Setup
Create a enviromental variables file for Dotenv `touch .env`
Create databases with `createdb iridescence_development && createdb iridescence_test`
Run development migrations with `rake db:migrate:up`
Run test migrations with `RACK_ENV=test rake db:migrate:up`
Run server with `rackup` or `shotgun` (for reloading)
#### Initialization
1. The `config.ru` loads the core application from `app/application.rb`
2. The core application file loads gems, sets up enviroment and loads lib directory with `config/boot.rb`
3. The application inherits from the base controller
4. The application loads and mounts all controllers
**NB**
1. All controllers should inherit from base controller where helper methods can be set
2. All by convention controllers each extend the view path with directory in their name
#### Tasks
All tasks are rake tasks loaded from the tasks directory
- List tasks `rake -T`
- Test all application code `rake test`
- Run test for single directory `rake test:`
**NB**
1. All test files must load test configuration
2. Controller tests must load application file
#### Tests
Test should inherit from *MyTest* this includes FactoryGirl methods and ensures that tests on the database are rolled back
#### Assets
Assets are available from `public`. To start purecss and font-awesome icons are included
## Components
#### Framework
**[Scorched](http://scorchedrb.com/)** -- Scorched is a generic, unopinionated, DRY, light-weight web framework for Ruby. It provides a generic yet powerful set of constructs for processing HTTP requests, with which websites and applications of almost any scale can be built.
If you've used a light-weight DSL-based Ruby web framework before, such as Sinatra, Scorched should look quite familiar. Scorched is a true evolutionary enhancement of Sinatra, with more power, focus, and less clutter.
#### Testing
**[Mini Test](https://github.com/seattlerb/minitest)** -- A small and incredibly fast unit testing framework.
It provides a rich set of assertions to make your tests clean and
readable.
**[Factory Girl](https://github.com/thoughtbot/factory_girl)** -- A library for setting up Ruby objects as test data.
## TODO
- sass ruby or gulp
- scorched rest
- browserify gulp only
new branch
- user accounts