TeaLeaves is the base Rails application used at bluetea.
This project was originally forked from Suspenders but has been heavily modified for our own internal usage
First install the tealeaves gem:
gem install tealeaves
Then run:
tealeaves projectname
This will create a Rails app in projectname using the latest version of Rails.
- Enable Circle CI Continuous Integration
- Enable GitHub auto deploys to Heroku staging and review apps.
To see the latest and greatest gems, look at Tealeaves' Gemfile, which will be appended to the default generated projectname/Gemfile.
It includes application gems like:
- Discard for managing soft deletion
- Sidekiq for background processing
- AppSignal for exception notification
- Oj
- Postgres for access to the Postgres database
- Rack Canonical Host to ensure all requests are served from the same domain
- Rack Timeout to abort requests that are taking too long
- Rails healthcheck for adding a healthcheck endpoint avoid accidentally sending emails to real people from staging
- Simple Form for form markup and style
- Title for storing titles in translations
And development gems like:
- Dotenv for loading environment variables
- Pry Rails for interactively exploring objects
- ByeBug for interactively debugging behavior
- Bullet for help to kill N+1 queries and unused eager loading
- Bundler Audit for scanning the Gemfile for insecure dependencies based on published CVEs
- Web Console for better debugging via in-browser IRB consoles.
And testing gems like:
- Factory Bot for test data
- Formulaic for integration testing HTML forms
- RSpec for unit testing
- RSpec Mocks for stubbing and spying
- Shoulda Matchers for common RSpec matchers
Tealeaves also comes with:
- The
./bin/setupconvention for new developer setup - The
./bin/deployconvention for deploying to Heroku - Rails' flashes set up and in application layout
- A few nice time formats set up for localization
Rack::Deflaterto compress responses with Gzip- A low database connection pool limit
- Safe binstubs
- t() and l() in specs without prefixing with I18n
- An automatically-created
SECRET_KEY_BASEenvironment variable in all environments - Configuration for stylelint
- The analytics adapter Segment (and therefore config for Google Analytics, Intercom, Facebook Ads, Twitter Ads, etc.)
- PostCSS Autoprefixer for CSS vendor prefixes
- PostCSS Normalize for resetting browser styles
- Hero Icons for rendering icons from the HeroIcon icon set
Read the documentation on deploying to Heroku
You can optionally create Heroku staging and production apps:
tealeaves app --heroku true
This:
- Creates a staging and production Heroku app
- Sets them as
stagingandproductionGit remotes - Configures staging with
APPSIGNAL_APP_ENVenvironment variable set tostaging - Creates a Heroku Pipeline for review apps
- Schedules automated backups for 10AM UTC for both
stagingandproduction
You can optionally specify alternate Heroku flags:
tealeaves app \
--heroku true \
--heroku-flags "--region eu --addons sendgrid,ssl"
See all possible Heroku flags:
heroku help create
This will initialize a new git repository for your Rails app. You can
bypass this with the --skip-git option:
tealeaves app --skip-git true
You can optionally create a GitHub repository for the suspended Rails app. It requires that you have Hub on your system:
brew install hub # macOS, for other systems see https://github.com/github/hub#installation
tealeaves app --github organization/project
This has the same effect as running:
hub create organization/project
Tealeaves requires the latest version of Ruby.
Some gems included in Tealeaves have native extensions. You should have GCC installed on your machine before generating an app with Tealeaves.
Use OS X GCC Installer for Snow Leopard (OS X 10.6).
Use Command Line Tools for Xcode for Lion (OS X 10.7) or Mountain Lion (OS X 10.8).
PostgreSQL needs to be installed and running for the db:create rake task.
Redis needs to be installed and running for Sidekiq
As well as the main app generator, Tealeaves comes with a number of other generators for enabling/disabling features as required
- Authentication - Add user authentication and login/logout functionality
- Authorization - Add a permission system to handle authorization
The resulting project is a standard Rails application, but comes pre-configured with a number of defaults. Below is an overview of the various features that come as standard, or as part of the other generators
If you have problems, please create a GitHub Issue.
Tealeaves is a long way from complete, and will continue to evolve as we develop more and more projects. Below is a list of features that are planned to be developed and incorporated into Tealeaves
-
UI components (UI Kit gem?):
- Layout
- Panels
- Sidebars
- Slideouts
- Modals
- Forms
-
MS 365 and Google workspace:
- Calendar sync
- Email sync
- Contacts sync
- SSO
-
CRM features:
- Tasks
- Activities
- Leads
- Contacts
- Accounts
- Timeline/history for all the above
-
Tables:
- Sorting
- Filtering
- Searching
- Lazy loading
-
Reporting:
- Report builder UI
- Export as CSV
- Export as PDF
-
Dashboards:
- Use reports as basis for dashboards
- Charts and graphs
-
Permissions:
- Expand to allow customisation of permissions