Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.46 KB

README.textile

File metadata and controls

83 lines (56 loc) · 3.46 KB
Raw

Welcome to BaseApp2

BaseApp2 is a default Ruby on Rails project that kick-starts your next Rails project.

Quickstart

Ok, before you dive in :-)

These 6 simple steps are the essentials to get you smoothly up and running…

  1. Create your own config/database.yml (you can copy one of the sample files in there and edit it)
  2. Edit the config/config.yml file to suit your needs
  3. Open a shell and run rake db:migrate to create your database and setup the prepared defaults.
  4. Start your server with ./script/server
  5. Open up http://localhost:3000 and login with username ‘admin’ and password ‘baseapp’.

Configatron vs. Settings

Previously, site settings were stored in the database. Now, you have two options for storing configuration settings.

1. Configatron config/config.yml

All default configuration options that are not ‘user changeable’ should go in config/config.yml. This uses the Configatron gem (frozen in vendor/gems).

To retrieve the site name you may use ‘configatron.site_name’ everywhere in your code.

2. Settings in database

It’s still possible to store user changeable settings in the database model Setting.

Note: As long as there are no Settings in the database, the ‘Settings’ tab for the administrator is hidden. Once you add a Setting to the database through a migration (or otherwise), the Settings tab will show up.

Asset Packaging

BaseApp makes use of the asset packager plugin, which compresses all of your javascript and stylesheet files into one file (and link) to speed up load times and in some ways development.

You can view details of the plugin at: http://github.com/sbecker/asset_packager

For quick starting though, all you need to do if you change the files, simply run:

rake asset:packager:build_all

Features

  • Layout
    • Tabs
    • Global links
    • Optional sidebar
    • Notice, warning and error flash messages
    • Both a default stylesheet as well as a ‘clean’ one are included for easy layout development.
  • Default dashboard page
  • Administration panel where you can:
    • Manage users (add, delete, purge, suspend, activate, send new passwords)
    • Manage settings
  • User authentication, with password recovery and login recovery and account activation (by email)
  • User Profiles:
    • Location, Website, Full name fields by default, easily extendible.
    • Gravatar for avatar support
  • Very useful Rails plugin available:
    • restful_authentication
    • acts_as_state_machine
    • asset_packager
  • Multi-stage deployments according to the D-TAP system (Development, Testing, Acceptance, Production). If you don’t want to use, production is the default deployment option. more info
  • Mobile Ready
    • Auto detect mobile users/visitors and display different views.
    • Based on the JQTouch framework, making it easy to theme.

Screenshots

Desktop Version
BaseApp2
BaseApp2

Mobile Version
BaseApp2 Mobile

Credits

BaseApp2 is developed by Danny McClelland, based on the BaseApp application.

BaseAPP is developed by Kabisa ICT, Ariejan de Vroom and a whole bunch of cool contributors.

BaseApp is released to the public under the MIT license.