bullet_train 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57c8825801aec411d4528065d7e35271bfce40a432f22485c8062a46b9401ab6
-  data.tar.gz: 213fb4a2b9bae25f866639e4b1e42879fac469c296232208a7a2af3dec9e5315
+  metadata.gz: 6e30b5befb225dec26f9c6b9dd3384b9650ee79020890066b9ecbaed9a5c2046
+  data.tar.gz: 5b91254dcd68f85ad541362e4f517b063f668ac4b08ff3d6267f6aee4ff8e9b6
 SHA512:
-  metadata.gz: 403f18cf271595467e8df348470ce49b4eb508ac35609b7c75e14699f33797a6dba98363f357c079f483a93f138491bcd8df7c3cb0c04ffba32c6d0421737c8d
-  data.tar.gz: 5b01d002d69d4d1b09cbbed6f64bc5b221e7e68babd61ca092f113717305b337c4c7922f226678d2e4faf55af4846ee20a823118d98ef7e1970bc08a05df1802
+  metadata.gz: 35358a72a094a00ba1cd5a6609bf0ebb4efe4c81d83a71b9761405c60aa5f91281e3d4574da07388d1db4b8a4eb67e75e284662b84c60d357cd4db8b3d3d8df5
+  data.tar.gz: 04ff45527fd1a13a598f1dadb5bf15c24d14f2040566b9c86f30c9bb3a181b0f8a85ecdf30b5ddc60337872b463e932104c41d4f093107508690684fd635c3c9

data/docs/field-partials/file-field.md

@@ -10,14 +10,6 @@ In addition, Bullet Train has integrated the direct-uploads feature of Active St
 
 The following steps illustrate how to add a `document` file attachment to a `Post` model.
 
-Add the following to `app/models/post.rb`:
-
-```ruby
-has_one_attached :document
-```
-
-Note, no database migration is required as ActiveStorage uses its own tables to store the attachments.
-
 Run the following command to generate the scaffolding for the `document` field on the `Post` model:
 
 ```bash
@@ -28,14 +20,6 @@ rails generate super_scaffold:field Post document:file_field
 
 The following steps illustrate how to add multiple `document` file attachments to a `Post` model.
 
-Add the following to `app/models/post.rb`:
-
-```ruby
-has_many_attached :documents
-```
-
-Note, no database migration is required as ActiveStorage uses its own tables to store the attachments.
-
 Run the following command to generate the scaffolding for the `documents` field on the `Post` model:
 
 ```bash

data/docs/heroku.md

@@ -1,8 +1,10 @@
 # Deploying to Heroku
 
-When you're ready to deploy to Heroku, it's highly recommended you use this button:
+## Taking Bullet Train for a test drive
 
-[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=http://github.com/bullet-train-co/bullet_train)
+If you just want to take this project for a test drive on Heroku without starting your own application you can use this button:
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://www.heroku.com/deploy?template=https://github.com/bullet-train-co/bullet_train)
 
 This button leverages the configuration found in `app.json`, including sensible demo-ready defaults for dyno formation, third-party services, buildpack configuration, etc.
 
@@ -10,6 +12,8 @@ The resources provisioned will cost about **$22/month**.
 
 **Please note:** The resources provisioned via `app.json` are intended to be used for quickly launching your brand new app so that you can demo it easily. When you're ready to go into production you'll want to make some changes to these resources. See the section at the bottom of this page.
 
+We also have a a demo site that you can try without needing to deploy anything. You can [sign up if you haven't tried it before](/users/sign_up) or if you can [sign in if you've already given it a test run](/users/sign_in).
+
 ## What's Included?
 
 ### Required Add-Ons
@@ -25,23 +29,87 @@ We've included the "entry-level" service tier across the board for:
  - [Honeybadger](https://www.honeybadger.io) for error tracking.
  - [Expedited Security](https://expeditedsecurity.com)'s [Real Email](https://elements.heroku.com/addons/realemail) to reduce accounts created with fake and unreachable emails, which will subsequently hurt your email deliverability.
 
-## Additional Required Steps
+## Deploying a real application
+
+When you're ready to deploy your own application based on Bullet Train there are a few steps that need to be performed manually using the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli):
+
+### 1. Clone the repo and bootstrap your app
+
+Follow the [normal instructions for getting started](https://github.com/bullet-train-co/bullet_train?tab=readme-ov-file#building-a-new-application-with-bullet-train)
+and during the `bin/configure` process be sure to choose to push your app to GitHub and to choose to add a "Deploy to Heroku" button.
+
+After doing that you'll have a copy of the starter repo that has been customized with your application name and settings.
+
+### 2. Deploy to Heroku using your own "Deploy to Heroku" button
+
+Now go to your repo on GitHub and look for the "Deploy to Heroku" button.
 
-Even after using the above button, there are a few steps that need to be performed manually using the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli):
+If you don't have one (or if it's not working right) you can add a new button to your README by running:
 
-### 1. Add Heroku as a Remote in Your Local Repository
+```
+./bin/configure-scripts/deploy_button_heroku.rb
+```
+
+After generating the button be sure to commit the change and push to your GitHub repo.
+
+Click the "Deploy to Heroku" button in your repo and you'll be taken to a screen where you can start the deployment process.
+
+### 3. Add Heroku as a Remote in Your Local Repository
+
+Once your application has been created use the name that you gave it to set up a git remote for `heroku`:
 
 ```
 heroku git:remote -a YOUR_HEROKU_APP_NAME
 ```
 
+### 4. Push to heroku
+
 After this, you'll be able to deploy updates to your app like so:
 
 ```
 git push heroku main
 ```
 
-### 2. Improve Boot Time
+## Configuring automatic deploys
+
+We include some pre-built workflows for GitHub actions that can run the test suite and automatically deploy your code to
+either a staging or a production environment.
+
+`.github/workflows/ci-cd-pipeline-main.yml` is a workflow that is run any time that new code lands on your `main` branch.
+
+At the bottom of the workflow is a block for automatically deploying to Heroku. It's commented out by default but you can un-comment
+it and set the `heroku-app-name` value to be the name of your new app in Heroku.
+
+If you don't want to deploy directly to production you could create a staging app in Heroku (by following the directions above but giving
+the new app a different name) and then add your staging and production apps to a pipeline. Then you could configure `ci-cd-pipeline-main.yml`
+to deploy to your staging app. Then you can use the Heroku pipeline functionality to promote versions of your app from staging to production.
+
+If you don't want to use Heroku pipelines but still want to have automated deploys to production that are triggered intentionally (not on every
+change to `main`) then you could duplicate `ci-cd-pipeline-main.yml` to something like `ci-cd-pipeline-production.yml` and change the conditions
+under which the workflow is run.
+
+For instance if you wanted to automatically deploy to production when a new verison tag is added to your GitHub repo you could change the `on:` block
+in the workflow file to be something like this:
+
+```
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+```
+
+With that you could then deploy to prod by doing something like this:
+
+```
+git tag v0.0.1
+git push origin --tags
+```
+
+Then the workflow would be triggered, it would run your test suite, and then deploy to whichever app you've configured in the workflow file.
+
+## Additional setup
+
+### 1. Improve Boot Time
 
 You can cut your application boot time in half by enabling the following Heroku Labs feature. See [this blog post](https://dev.to/dbackeus/cut-your-rails-boot-times-on-heroku-in-half-with-a-single-command-514d) for more details.
 
@@ -49,7 +117,7 @@ You can cut your application boot time in half by enabling the following Heroku
 heroku labs:enable build-in-app-dir
 ```
 
-### 3. Adding Your Actual Domain
+### 2. Adding Your Actual Domain
 
 The most common use case for Bullet Train applications is to be hosted at some appropriate subdomain (e.g. `app.YOURDOMAIN.COM`) while a marketing site is hosted with a completely different service at the apex domain (e.g. just `YOURDOMAIN.COM`) or `www.YOURDOMAIN.COM`. To accomplish this, do the following in your shell:
 
@@ -81,7 +149,7 @@ heroku certs:auto
 
 You should be done now and your app should be available at `https://app.YOURDOMAIN.COM/account` and any hits to `https://app.YOURDOMAIN.COM` (e.g. when users sign out, etc.) will be redirected to your marketing site.
 
-### 4. Configure CORS on Your S3 Bucket
+### 3. Configure CORS on Your S3 Bucket
 
 Before you can upload to your freshly provisioned S3 bucket, you need to run (on Heroku) a rake task we've created for you to set the appropriate CORS settings.
 

data/docs/themes.md

@@ -8,6 +8,44 @@ To reduce duplication of code across themes, Bullet Train implements the followi
 
 This is where all of Bullet Train's standard views are contained.
 
+## Adding a New Theme (CSS only)
+
+The easiest way to get started customizing Bullet Train is by definiing a custom set of primary and secondary colors for your own theme.
+
+Open `app/assets/stylesheets/application.css` then define a new set of colors with a custom theme name. Something like this:
+
+```css
+.theme-foo {
+  --primary-50: #fff6e0;
+  --primary-100: #ffebb3;
+  --primary-200: #ffdf80;
+  --primary-300: #ffd24d;
+  --primary-400: #ffc71f;
+  --primary-500: #F2B705;
+  --primary-600: #d99804;
+  --primary-700: #b07803;
+  --primary-800: #865802;
+  --primary-900: #5c3901;
+
+  --secondary-50: #fde8ea;
+  --secondary-100: #fac9ce;
+  --secondary-200: #f19aa2;
+  --secondary-300: #e76b76;
+  --secondary-400: #dc3e4c;
+  --secondary-500: #BF2431;
+  --secondary-600: #9b1c28;
+  --secondary-700: #77151f;
+  --secondary-800: #530e15;
+  --secondary-900: #32080d;
+}
+```
+
+Then open `config/initializers/theme.rb` and change the theme name like this:
+
+```ruby
+BulletTrain::Themes::Light.color = :foo
+```
+
 ## Adding a New Theme (ejecting standard views)
 
 If you want to add a new theme, you can use the following command. For example, let's make a new theme called "foo":
@@ -83,4 +121,4 @@ You're going to have to call your theme something and there are practical reason
 ## Additional Themes Documentation
 
 * [Installing Bullet Train Themes on Other Rails Projects](/docs/themes/on-other-rails-projects.md)
-* [Installing Bullet Train Themes on Jumpstart Pro Projects](/docs/themes/on-jumpstart-pro-projects.md)
+* [Installing Bullet Train Themes on Jumpstart Pro Projects](/docs/themes/on-jumpstart-pro-projects.md)

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.8.0"
+  VERSION = "1.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard