Lightning Rails

https://docs.lightningrails.com
Admin
Lightning Rails is a Ruby on Rails boilerplate designed to help developers launch MVPs quickly with...
Tokens:20,322
Snippets:177
Trust Score:5.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Clone Lightning Landing Repository

Source: https://docs.lightningrails.com/getting-started/lightning-landing/quickstart

This command clones the official Lightning Landing repository to your local machine using the GitHub CLI. It sets up the initial project structure. Ensure you have the GitHub CLI installed and are authenticated.

```Shell
gh repo clone LightningRails/lightning-landing mysupercoolpage
```

--------------------------------

### Install Heroku CLI on Ubuntu

Source: https://docs.lightningrails.com/deploying-to-production

Installs the Heroku Command Line Interface on Ubuntu systems using a provided installation script.

```shell
curl https://cli-assets.heroku.com/install.sh | sh
heroku --version
```

--------------------------------

### Lightning Landing Repository Setup

Source: https://docs.lightningrails.com/getting-started/lightning-landing/quickstart

After cloning the Lightning Landing repository, it's crucial to remove the default GitHub origin to prevent accidental pushes to the source repository. This step ensures your local project is independent. You will then create a new remote origin pointing to your own repository.

```Shell
# Remove the default origin
git remote remove origin

# Create a new origin (replace with your repository URL)
git remote add origin <your-new-repository-url>
```

--------------------------------

### Repository Management and Deployment

Source: https://docs.lightningrails.com/getting-started/lightning-landing/quickstart

Commands for managing Git remotes, creating a new GitHub repository, committing changes, and pushing to the new origin. Includes GitHub CLI usage for repository creation and viewing.

```shell
cd mysupercoolpage
```

```git
git remote remove origin
```

```gh
gh repo create --public --source=. --push
```

```git
git add .
git commit -m "First commit"
```

```git
git push origin master
```

```gh
gh repo view -w
```

```shell
serve
```

--------------------------------

### Install Heroku CLI on Ubuntu

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Installs the Heroku Command Line Interface on Ubuntu systems using a provided installation script.

```shell
curl https://cli-assets.heroku.com/install.sh | sh
heroku --version
```

--------------------------------

### Install Heroku CLI on macOS

Source: https://docs.lightningrails.com/deploying-to-production

Installs the Heroku Command Line Interface using Homebrew. Includes a fix for potential 'Bad CPU type' errors on Apple Silicon Macs.

```shell
brew tap heroku/brew && brew install heroku
heroku --version

# If you get 'Bad CPU type in executable' error:
softwareupdate --install-rosetta --agree-to-license
heroku --version
```

--------------------------------

### Install and Setup Motor Admin

Source: https://docs.lightningrails.com/features-setup/markdown

Guides users through installing Motor Admin, a Ruby on Rails admin panel, and setting up an initial admin user via the Rails console.

```bash
rails c
```

```ruby
> User.create(email: "[email protected]", password:"somesecurepassword", admin: true)
```

--------------------------------

### Install Heroku CLI on macOS

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Installs the Heroku Command Line Interface using Homebrew. Includes a fix for potential 'Bad CPU type' errors on Apple Silicon Macs.

```shell
brew tap heroku/brew && brew install heroku
heroku --version

# If you get 'Bad CPU type in executable' error:
softwareupdate --install-rosetta --agree-to-license
heroku --version
```

--------------------------------

### Run Project Setup Script

Source: https://docs.lightningrails.com/getting-started/quickstart

Navigates into the cloned project directory and executes a setup script. This script prompts for project-specific information, which can also be configured later in the `meta.yml` file.

```bash
cd mysupercoolapp
bash generators/setup.sh
```

--------------------------------

### Run Project Setup Script

Source: https://docs.lightningrails.com/getting-started

Navigates into the cloned project directory and executes a setup script. This script prompts for project-specific information, which can also be configured later in the `meta.yml` file.

```bash
cd mysupercoolapp
bash generators/setup.sh
```

--------------------------------

### Bundle Install Gems

Source: https://docs.lightningrails.com/features-setup/github-signup

Executes the bundle install command to install the gems specified in the Gemfile.

```shell
bundle install
```

--------------------------------

### Start Development Server

Source: https://docs.lightningrails.com/getting-started/quickstart

Starts the development server for your Lightning Rails application. It uses `bin/dev` which ensures that Tailwind.css is compiled along with the server, unlike the standard `rails s` command.

```shell
bin/dev
```

--------------------------------

### Postmark Setup for Transactional Emails

Source: https://docs.lightningrails.com/features-setup/automatic-emails/editor

Guides users through the process of setting up Postmark for transactional emails in their LightningRails application. It covers account creation, email confirmation, and important notes on usage.

```markdown
## 🟨Postmark

### Step 1: Create an Account on Postmark

1. **Visit the Postmark Website**: Go to [Postmark's official website](https://postmarkapp.com/).
2. **Sign Up**: Click on the “Sign Up” button typically located at the top right of the homepage.
3. **Fill in Your Details**: Enter your email address, password, and any other required information to create a new account.
4. **Confirm Your Email**: Check your inbox for a confirmation email from Postmark. Click the link in the email to verify your account.
5. **Set Up Your Account**: Log in to your newly created account and complete the setup process as prompted. This may include providing additional information about your business or intended use of the service. ❗️ Make sure to mention that **you are using postmark for transactional emails** (welcome emails, payment confirmation etc...) and in NO case for promotional emails.
```

--------------------------------

### Start Development Server

Source: https://docs.lightningrails.com/getting-started

Starts the development server for your Lightning Rails application. It uses `bin/dev` which ensures that Tailwind.css is compiled along with the server, unlike the standard `rails s` command.

```shell
bin/dev
```

--------------------------------

### Start Development Server

Source: https://docs.lightningrails.com/resources

Starts the development server to test the updated application.

```shell
dev
```

--------------------------------

### RubyLLM Basic Usage Example

Source: https://docs.lightningrails.com/features-setup/multi-provider-ai

A minimal example demonstrating how to call the `ask` method on a chat instance for a simple query. Useful for troubleshooting or basic testing.

```ruby
RubyLLM.chat.ask("Hello, how are you?")
```

--------------------------------

### Start Development Server

Source: https://docs.lightningrails.com/resources/updating-lightning-rails

Starts the development server to test the updated application.

```shell
dev
```

--------------------------------

### Install Gems with Bundler

Source: https://docs.lightningrails.com/features-setup/automatic-emails/resend

Executes the bundle install command to download and install all gems listed in the Gemfile, including the newly added Resend gem.

```Bash
bundle install

```

--------------------------------

### Create a Heroku App

Source: https://docs.lightningrails.com/deploying-to-production

Creates a new application on Heroku and associates it with your local project directory. It's recommended to specify a region for correct time zone handling.

```shell
heroku create myawesomeapp --region eu
```

--------------------------------

### Push to Heroku Production

Source: https://docs.lightningrails.com/deploying-to-production

Deploys your committed code changes to the Heroku production environment using Git.

```shell
git push heroku master
```

--------------------------------

### Install ruby_llm Gem Directly

Source: https://docs.lightningrails.com/features-setup/multi-provider-ai

An alternative method to install the ruby_llm gem directly from the command line.

```Shell
gem install ruby_llm
```

--------------------------------

### Install and Login to Stripe CLI

Source: https://docs.lightningrails.com/features-setup/stripe-payment-gateway

Instructions for installing the Stripe CLI on macOS using Homebrew and logging in with an API key to test webhooks in development. This is essential for local testing of Stripe integrations.

```bash
brew install stripe/stripe-cli/stripe

stripe login -i
```

--------------------------------

### Login to Heroku CLI

Source: https://docs.lightningrails.com/deploying-to-production

Authenticates your terminal session with Heroku, allowing you to manage your applications directly from the command line.

```shell
heroku login
```

--------------------------------

### Create a Heroku App

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Creates a new application on Heroku and associates it with your local project directory. It's recommended to specify a region for correct time zone handling.

```shell
heroku create myawesomeapp --region eu
```

--------------------------------

### Install ruby_llm Gem

Source: https://docs.lightningrails.com/features-setup/multi-provider-ai

Add the ruby_llm gem to your project's Gemfile and install it using Bundler.

```Ruby
gem "ruby_llm"
```

```Shell
bundle install
```

--------------------------------

### Push to Heroku Production

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Deploys your committed code changes to the Heroku production environment using Git.

```shell
git push heroku master
```

--------------------------------

### Migrate and Seed Database on Heroku

Source: https://docs.lightningrails.com/deploying-to-production

Runs pending database migrations and seeds the production database using Heroku CLI commands. Ensure your local database is migrated before pushing to production.

```shell
heroku run rails db:migrate
heroku run rails db:seed
```

--------------------------------

### Install Active Storage and Migrate Database

Source: https://docs.lightningrails.com/features-setup

Installs Active Storage and applies database migrations to set up tables for file management. This prepares the application to handle file attachments.

```shell
rails active_storage:install
rails db:migrate
```

--------------------------------

### Install Active Storage and Migrate Database

Source: https://docs.lightningrails.com/features-setup/images-and-media

Installs Active Storage and applies database migrations to set up tables for file management. This prepares the application to handle file attachments.

```shell
rails active_storage:install
rails db:migrate
```

--------------------------------

### Lightning Landing Navbar Example

Source: https://docs.lightningrails.com/getting-started/lightning-landing/page-structure

Illustrates the default navigation bar component in the Lightning Landing boilerplate. It highlights key elements like logo, company name, and menu items, offering best practices for user engagement.

```markdown
### Navigation Bar

![](https://docs.lightningrails.com/~gitbook/image?url=https%3A%2F%2F2221554152-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FPCf6vtFuZEPHXJd7JfIe%252Fuploads%252FUnskSQLqBH4cyv7E7o8S%252FScreenshot%25202024-12-03%2520at%252012.12.10.png%3Falt%3Dmedia%26token%3Dece0b995-7f8d-470e-a19c-9e905aa229fe&width=768&dpr=4&quality=100&sign=4939877e&sv=2)

Navbar in Lightning Landing boilerplate

The fixed navigation bar stays at the top of the page and contains your logo, company name, and main menu items.

Pro Tips:

* Keep menu items minimal (3-4 items) to avoid overwhelming visitors
* Use clear, action-oriented labels
* Include your logo and company name for immediate brand recognition
```

--------------------------------

### Install Project Dependencies

Source: https://docs.lightningrails.com/resources

Installs or updates project dependencies using Bundler.

```ruby
bundle install
```

--------------------------------

### Migrate and Seed Database on Heroku

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Runs pending database migrations and seeds the production database using Heroku CLI commands. Ensure your local database is migrated before pushing to production.

```shell
heroku run rails db:migrate
heroku run rails db:seed
```

--------------------------------

### Login to Heroku CLI

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Authenticates your terminal session with Heroku, allowing you to manage your applications directly from the command line.

```shell
heroku login
```

--------------------------------

### Set API Credentials via Heroku Config

Source: https://docs.lightningrails.com/deploying-to-production

Configures environment variables on Heroku for API keys, such as Postmark API. Replace YOUR_API_KEY with your actual key.

```shell
heroku config:set postmark_api=YOUR_API_KEY
```

--------------------------------

### Install Project Dependencies

Source: https://docs.lightningrails.com/resources/updating-lightning-rails

Installs or updates project dependencies using Bundler.

```ruby
bundle install
```

--------------------------------

### View Heroku Application Logs

Source: https://docs.lightningrails.com/deploying-to-production

Accesses and tails the logs for your Heroku application to diagnose errors or monitor activity. This command is useful when troubleshooting issues encountered after deployment or during runtime.

```shell
heroku logs --tail
```

--------------------------------

### Install Omniauth Github Gem

Source: https://docs.lightningrails.com/features-setup/github-signup

Adds the necessary omniauth and omniauth-github gems to the application's Gemfile for GitHub authentication.

```ruby
gem 'omniauth'
gem 'omniauth-rails_csrf_protection'
gem 'omniauth-github'
```

--------------------------------

### Install OpenAI Ruby Gem

Source: https://docs.lightningrails.com/features-setup/open-ai-api

Adds the ruby-openai gem to your project's Gemfile and installs it using Bundler. This gem provides the interface to interact with the OpenAI API.

```ruby
gem "ruby-openai"

```

```bash
bundle install

```

--------------------------------

### Welcome Email HTML Content

Source: https://docs.lightningrails.com/features-setup/automatic-emails/resend

Provides an example of HTML content for the welcome email, using ERB to dynamically insert user data like the name.

```erb
<h1>Welcome to Our App, <%= @user.name %>!</h1>
<p>We’re excited to have you on board.</p>
```

--------------------------------

### Set API Credentials via Heroku Config

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Configures environment variables on Heroku for API keys, such as Postmark API. Replace YOUR_API_KEY with your actual key.

```shell
heroku config:set postmark_api=YOUR_API_KEY
```

--------------------------------

### View Heroku Application Logs

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Accesses and tails the logs for your Heroku application to diagnose errors or monitor activity. This command is useful when troubleshooting issues encountered after deployment or during runtime.

```shell
heroku logs --tail
```

--------------------------------

### Lightning Landing Page Structure

Source: https://docs.lightningrails.com/getting-started/lightning-landing/page-structure

Details the default landing page design in Lightning Landing, emphasizing flexibility and integration with component libraries like DaisyUI and HyperUI. It guides users on customizing sections to meet conversion goals.

```markdown
# Page structure

Let's decide what makes a great landing page, do we want Testimonials? Pricing? ....

Lightning Landing comes with one landing page design by default. All the sections are carefully designed and placed to guide the visitor toward converting into a user or potential customer.
Please feel free to change any existing section with any other design from the following libraries, The boilerplate has DaisyUI and Tailwind by default so any of the components can easily be copy-pasted:

* [**DaisyUI**](https://daisyui.com/components)components library
* [**HyperUI**](https://www.hyperui.dev/) Tailwind components library
```

--------------------------------

### Example Log Output for Throttled Request

Source: https://docs.lightningrails.com/deploying-to-production/security/rate-limiting

This is an example of what a log entry might look like when rack-attack throttles a request. It indicates the IP address of the client that exceeded the defined rate limits.

```log
[Rack::Attack] Throttled: 192.168.1.100
```

--------------------------------

### Define Magic Link Routes

Source: https://docs.lightningrails.com/features-setup/magic-link-signup

Adds POST and GET routes to handle the creation of magic links and the validation of the token, respectively.

```ruby
post 'email_links/create', as: :magic_link
get 'email_links/validate', as: :email_link
```

--------------------------------

### Add rack-attack Gem to Gemfile

Source: https://docs.lightningrails.com/deploying-to-production/security/rate-limiting

Add the rack-attack gem to your project's Gemfile to enable rate limiting functionality. After adding the gem, install it using the bundle install command.

```ruby
gem 'rack-attack'
```

```shell
bundle install
```

--------------------------------

### Configure Stripe Live API Keys and Webhook Secret

Source: https://docs.lightningrails.com/deploying-to-production

Sets Stripe live API keys and the webhook signing secret as environment variables on Heroku. Obtain live keys from your Stripe dashboard and the signing secret after setting up a webhook endpoint.

```shell
heroku config:set STRIPE_PUBLIC_KEY=****
heroku config:set STRIPE_PRIVATE_KEY=****
heroku config:set STRIPE_SIGNING_SECRET=*****
```

--------------------------------

### Listen to Stripe Webhooks (Shell)

Source: https://docs.lightningrails.com/features-setup/stripe-payment-gateway

Starts a local Stripe CLI listener to forward webhook events to your application. This is crucial for testing webhook functionality during development.

```shell
stripe listen --forward-to localhost:3000/pay/webhooks/stripe
```

--------------------------------

### Ruby Controller for Product Analysis

Source: https://docs.lightningrails.com/features-setup/open-ai-api

Demonstrates how to implement a product analysis feature within a Ruby on Rails controller. It retrieves product information from request parameters, instantiates the `OpenAiApi` service, and calls its `analyze_product` method to get the analysis results.

```ruby
class ProductsController < ApplicationController
  def analyze
    @product = params[:product]
    openai_service = OpenAiApi.new
    @analysis = openai_service.analyze_product(@product)
  end
end
```

--------------------------------

### Configure Stripe Live API Keys and Webhook Secret

Source: https://docs.lightningrails.com/deploying-to-production/heroku-deploy

Sets Stripe live API keys and the webhook signing secret as environment variables on Heroku. Obtain live keys from your Stripe dashboard and the signing secret after setting up a webhook endpoint.

```shell
heroku config:set STRIPE_PUBLIC_KEY=****
heroku config:set STRIPE_PRIVATE_KEY=****
heroku config:set STRIPE_SIGNING_SECRET=*****
```

--------------------------------

### Register Stimulus Controllers in Application.js

Source: https://docs.lightningrails.com/features-setup/multi-step-form-wizard

Configuration snippet for `application.js` to ensure Stimulus controllers are registered and available for use in the application. This is a standard setup for Hotwire/Stimulus in Rails.

```javascript
// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails
import "@hotwired/turbo-rails"
import "controllers"
```

--------------------------------

### Style Lucide Icon with `lucide_icon` Helper

Source: https://docs.lightningrails.com/features-setup/lucide-icons

Shows how to customize the appearance of a Lucide icon by passing additional arguments to the `lucide_icon` helper. This example applies CSS classes to control the icon's size.

```erb
<%= lucide_icon("move-right", "class" => "h-4 w-4") %>
```

--------------------------------

### Tailwind CSS 4 Setup in LightningRails

Source: https://docs.lightningrails.com/getting-started/publish-your-docs

LightningRails utilizes Tailwind CSS 4 for enhanced performance and development experience. The configuration is managed within `app/assets/tailwind/application.css`. Key benefits include faster builds, better Rails asset pipeline integration, and flexibility for custom configurations.

```text
Configuration file location:
app/assets/tailwind/application.css
```

--------------------------------

### Initialize and Send Mailer in Rails Console

Source: https://docs.lightningrails.com/features-setup/automatic-emails/resend

Demonstrates how to instantiate a user object, initialize the mailer with the user, and deliver the email immediately using the Rails console.

```shell
rails console
```

```ruby
u = User.new(name: "Derich", email: "[email protected]")
mailer = UserMailer.with(user: u).welcome_email
mailer.deliver_now!
```

--------------------------------

### APIDOC: Marketing Copy Generation Prompt Structure

Source: https://docs.lightningrails.com/features-setup/open-ai-api

Documents a comprehensive prompt designed for AI models to generate marketing copy for product launches. It specifies a system message for role-playing an expert copywriter and a user message detailing the goal, context from past successful launches, new product information, warnings, constraints, a template for the first product introduction comment, and the required return format.

```APIDOC
messages: [
  { role: "system", content: "You are an expert copywriter specializing in creating engaging, persuasive, and high-converting copy for product launches. Your expertise includes analyzing industry trends, top-performing messaging strategies, and user psychology to craft compelling and attention-grabbing text." },

  {
    role: "user", content: "
### **🎯 Goal**
Your task is to generate **engaging, high-quality marketing copy** for a new product based on inspiration from past successful launches. Your response should include:
- **A compelling product title** (short, catchy, and memorable).
- **A tagline** (one-liner that sparks curiosity and communicates value).
- **A persuasive product description** (concise, engaging, and benefit-driven).
- **A first comment/post to introduce the product** (structured for maximum engagement).

---
### **📊 Context: Past Successful Launches**
Below are examples of **top-performing product launches**, including their titles, taglines, and descriptions. Use these as **inspiration** to generate high-quality copy:

**Top Titles:**
{TOP_TITLES_PLACEHOLDER}

**Top Taglines:**
{TOP_TAGLINES_PLACEHOLDER}

**Top Descriptions:**
{TOP_DESCRIPTIONS_PLACEHOLDER}

---
### **📝 New Product Information**
The new product is described as follows:

**Product Name:** {PRODUCT_NAME_PLACEHOLDER}
**Category:** {CATEGORY_PLACEHOLDER}
**Product Summary:**
{PRODUCT_SUMMARY_PLACEHOLDER}

---
### **⚠️ Warnings & Constraints**
- The **title must be under 7 words** and be memorable.
- The **tagline should create curiosity and communicate value clearly**.
- The **description should be benefit-driven, avoiding unnecessary fluff**.
- The **first comment/post should feel natural, engaging, and encourage interaction**.
- Avoid **generic language**—be concise and persuasive.
- Structure the response so it is **easy to read and scan quickly**.

---
### **🗣️ First Product Introduction Comment Template**
Use this structure to craft the first comment/post:

🔥 **Hey everyone!** 🎯

I'm super excited to introduce **{PRODUCT_NAME_PLACEHOLDER}** today! 🚀

As {TARGET_AUDIENCE_PLACEHOLDER}, we all struggle with **{PROBLEM_PLACEHOLDER}**. It can be frustrating to {describe the pain point in a relatable way}. 🤔

I built **{PRODUCT_NAME_PLACEHOLDER}** to **{briefly describe how it solves the problem}**, making {your audience’s goal} easier and more effective. Some cool features:
✅ **{FEATURE_1_PLACEHOLDER}** - {Short description}
✅ **{FEATURE_2_PLACEHOLDER}** - {Short description}
✅ **{FEATURE_3_PLACEHOLDER}** - {Short description}

Would love to hear your thoughts! **How would you use {PRODUCT_NAME_PLACEHOLDER}?** Let me know in the comments! 💡👇

---
### **📑 Return Format**
Ensure your response follows this structure for easy readability:

**Title:**
(Short, engaging title)

**Tagline:**
(One-liner tagline)

**Description:**
(A concise, persuasive product description)

**First Comment/Post:**
(Engaging, structured introduction post following the given template)

---
💡 **Final Notes:**
- Be **creative but keep it natural**—avoid sounding robotic.
- Use **persuasive storytelling techniques**—highlight real-world benefits.
- Keep everything **clear, engaging, and optimized for conversions**.

```

--------------------------------

### Create OmniAuth Callbacks Controller File

Source: https://docs.lightningrails.com/features-setup/github-signup

Creates the Ruby file for the OmniAuth callbacks controller, which will handle responses from OAuth providers.

```shell
touch app/controllers/users/omniauth_callbacks_controller.rb
```

--------------------------------

### Clone Lightning Rails Repository

Source: https://docs.lightningrails.com/getting-started/quickstart

Clones the Lightning Rails repository to your local machine. It's recommended to remove the default GitHub origin and create a new one to avoid pushing your code to the source repository.

```shell
gh repo clone LightningRails/lightning-rails mysupercoolapp

# After cloning, fix the origin:
# git remote remove origin
# git remote add origin <your-new-repo-url>
```

--------------------------------

### Configure Ruby LLM Gem

Source: https://docs.lightningrails.com/features-setup/multi-provider-ai

Sets up API keys for various LLM providers by reading them from environment variables. This is typically done in an initializer file.

```ruby
RubyLLM.configure do |config|
  config.openai_api_key = ENV['OPENAI_API_KEY']
  config.anthropic_api_key = ENV['ANTHROPIC_API_KEY']
  config.gemini_api_key = ENV['GEMINI_API_KEY']
  config.deepseek_api_key = ENV['DEEPSEEK_API_KEY']
end
```

--------------------------------

### RubyLLM API Reference

Source: https://docs.lightningrails.com/features-setup/multi-provider-ai

Provides core methods and concepts for interacting with the RubyLLM gem, including configuration, chat initialization, message handling, and tool usage.

```APIDOC
RubyLLM:
  configure(options = {})
    Sets global configuration options for the gem.
    Options:
      openai_api_key: String - API key for OpenAI.
      anthropic_api_key: String - API key for Anthropic.
      gemini_api_key: String - API key for Google Gemini.
      deepseek_api_key: String - API key for DeepSeek.

  chat(options = {})
    Initializes a new chat session with a specified model.
    Options:
      model: String - The LLM model to use (e.g., "gpt-4o-mini").
      temperature: Float - Controls randomness (0.0 to 2.0).
      max_tokens: Integer - Maximum tokens for the response.
    Returns: Chat instance.

Chat:
  add_message(role:, content:)
    Adds a message to the chat history.
    Parameters:
      role: Symbol - The role of the message sender (:system, :user, :assistant).
      content: String - The message content.

  ask(prompt, &block)
    Sends a prompt to the LLM and returns the response.
    If a block is provided, it streams chunks of the response.
    Parameters:
      prompt: String - The user's query or prompt.
    Returns: Response object or streams chunks if block is given.

Response Object:
  content: String - The full text content of the LLM's response.
  finish_reason: String - Reason for stopping generation (e.g., 'stop', 'length').

RubyLLM::Tool:
  define(name:, description:, parameters:)
    Defines a tool that the LLM can call.
    Parameters:
      name: String - The name of the tool.
      description: String - A description of what the tool does.
      parameters: Hash - JSON schema defining tool parameters.

  call(tool_name, arguments)
    Executes a defined tool with provided arguments.

Best Practices:
- Use `RubyLLM.chat(model: "model_name")` for specific model tasks.
- Implement streaming for real-time UI updates.
- Leverage multi-modal inputs (images, PDFs, audio) for advanced features.
- Use `RubyLLM::Tool` for dynamic, callable actions.
- Sanitize and validate user input before using it in prompts.

Troubleshooting:
- Missing API key: Ensure `.env` has the correct key and `dotenv` is loaded.
- `undefined method acts_as_chat`: Verify ActiveRecord models are set up with `acts_as_chat` and the gem is loaded. Restart server if needed.
- No response from `ask`: Wrap calls in `puts` or logging; try a basic prompt like `RubyLLM.chat.ask("Hello, how are you?")`.
```

--------------------------------

### Implement GitHub OmniAuth Callback Controller

Source: https://docs.lightningrails.com/features-setup/github-signup

Contains the Ruby code for the `Users::OmniauthCallbacksController` to process the GitHub OAuth callback, find or create a user, and manage the sign-in process.

```ruby
# app/controllers/users/omniauth_callbacks_controller.rb

class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
  def github
      @user = User.from_omniauth(request.env['omniauth.auth'])

      if @user.persisted?
        sign_in_and_redirect @user, event: :authentication
        flash[:notice] = I18n.t 'devise.omniauth_callbacks.success', kind: 'Github'
      else
        session['devise.github_data'] = request.env['omniauth.auth'].except('extra') 
        redirect_to new_user_registration_url, alert: @user.errors.full_messages.join("\n")
      end
  end
end
```

--------------------------------

### Create OmniAuth Callbacks Controller Directory

Source: https://docs.lightningrails.com/features-setup/github-signup

Creates the necessary directory structure for the OmniAuth callbacks controller within the Rails application.

```shell
mkdir app/controllers/users
```

--------------------------------

### Clone Lightning Rails Repository

Source: https://docs.lightningrails.com/getting-started

Clones the Lightning Rails repository to your local machine. It's recommended to remove the default GitHub origin and create a new one to avoid pushing your code to the source repository.

```shell
gh repo clone LightningRails/lightning-rails mysupercoolapp

# After cloning, fix the origin:
# git remote remove origin
# git remote add origin <your-new-repo-url>
```

--------------------------------

### Create ruby_llm Initializer

Source: https://docs.lightningrails.com/features-setup/multi-provider-ai

Create a new Ruby initializer file to configure the ruby_llm gem.

```Shell
touch config/initializers/ruby_llm.rb
```

--------------------------------

### Render Basic FAQ Component (Ruby)

Source: https://docs.lightningrails.com/ui-components/faqs

This snippet demonstrates how to render the basic FAQ section component in your application. It relies on the pre-defined `components/faq` partial, which is built using DaisyUI and TailwindCSS.

```erb
<%= render "components/faq" %>
```

--------------------------------

### Lightning Rails Configuration

Source: https://docs.lightningrails.com/getting-started/lightning-landing/theme-and-branding

Configuration options for Lightning Rails, including settings for custom logos, favicons, and potentially other branding elements. Specific configuration files or methods are not detailed in the provided text, but the concept is mentioned.

```apidoc
LightningRails:
  # Configuration for custom logo and favicon
  # Example:
  # logo: "/assets/images/custom_logo.png"
  # favicon: "/assets/images/custom_favicon.ico"

  # Theme settings are typically managed via HTML attributes as shown in other examples.
```

--------------------------------

### Configure GitHub Credentials in .env

Source: https://docs.lightningrails.com/features-setup/github-signup

Adds GitHub OAuth credentials (Client ID and Secret) to the application's environment variables file for secure access.

```env
# .env

# modify with your keys
GITHUB_ID=Ov23*********
GITHUB_SECRET=3cc73c***********************
```

--------------------------------

### Create Rack Attack Initializer File

Source: https://docs.lightningrails.com/deploying-to-production/security/rate-limiting

This command creates the configuration file for rack-attack within the Rails application's initializers directory. This file will contain all custom rate limiting rules.

```shell
touch config/initializers/rack_attack.rb
```

--------------------------------

### Configure API Keys

Source: https://docs.lightningrails.com/features-setup/multi-provider-ai

Set up your API keys for various LLM providers in the .env file, which is managed by dotenv-rails in Lightning Rails projects.

```Env
OPENAI_API_KEY=sk-...
# Add others as needed
# ANTHROPIC_API_KEY=...
# GEMINI_API_KEY=...
# DEEPSEEK_API_KEY=...
```

--------------------------------

### OpenAI API Service in Ruby

Source: https://docs.lightningrails.com/features-setup/open-ai-api

Defines a Ruby class `OpenAiApi` to interact with the OpenAI API. It initializes with an access token from environment variables and provides a method `analyze_product` to send product details to a GPT model for analysis, returning the model's response.

```ruby
class OpenAiApi
  def initialize
    @client = OpenAI::Client.new(access_token: ENV["OPENAI_ACCESS_TOKEN"])
  end

  def analyze_product(product)
    chatgpt_response = @client.chat(parameters: {
      model: "gpt-4o-mini",
      messages: [
        { role: "system", content: "You are a product analyst expert specialized in evaluating digital products and services. You have deep knowledge of market trends, user experience, and business models. Your analysis should be structured, data-driven, and actionable." },
        { role: "user", content: "Here is a product to analyze: #{product}. Please follow this process:\n\n1. Identify the key features and unique selling points\n2. Evaluate the market potential and target audience\n3. Analyze pricing strategy and business model\n4. Assess technical implementation and scalability\n5. Provide specific recommendations for improvement\n\nFormat your response in clear sections with bullet points where appropriate. Be concise but thorough in your analysis." }
      ]
    })
    chatgpt_response["choices"][0]["message"]["content"]
  end
end
```

--------------------------------

### Render Full Width FAQ Component (Ruby)

Source: https://docs.lightningrails.com/ui-components/faqs

This snippet shows how to include the full-width FAQ section with '+' signs. It uses the `components/faq_full` partial, leveraging DaisyUI and TailwindCSS for styling and functionality.

```erb
<%= render "components/faq_full" %>
```

--------------------------------

### Implement User.from_omniauth Method

Source: https://docs.lightningrails.com/features-setup/github-signup

Defines the `User.from_omniauth` class method to process the OmniAuth data, find an existing user by email, or create a new user with provided GitHub details.

```ruby
# models/user.rb
class User < ApplicationRecord
  # has_one_attached :avatar <- Uncomment If you want to attach a picture from github
  # [...] 

  def self.from_omniauth(access_token)
    data = access_token.info
    user = User.where(email: data['email']).first
    if user
       user.update(
          # Optional: You can create a migration for users to add GitHub username and name to the user instance.
          # github_username: data['nickname'],
          # name: data['name'],
          email: data['email']
       )
    else
        user = User.create(
           # Optional: You can create a migration for users to add GitHub username and name to the user instance.
           # github_username: data['nickname'],
           # name: data['name'],
           email: data['email'],
           password: Devise.friendly_token[0,20]
        )
    end
     # Optional: Uncomment for adding avatar image from github, make sure you have a cloudinary API_KEY in your .env
     # user.avatar.purge if user.avatar.attached?
     # user.avatar.attach(io: URI.open(data['image']), filename: 'avatar.jpg', content_type: 'image/jpg')
    user
  end
end
```

--------------------------------

### OpenAI API Integration

Source: https://docs.lightningrails.com/getting-started/lightning-landing/page-structure

This section describes the integration with the OpenAI API as a feature within LightningRails. It implies that the project supports multi-provider AI capabilities, with OpenAI being one of them.

```APIDOC
Feature: Multi-provider AI

Description: Enables integration with various AI providers to leverage advanced AI functionalities within the application.

Supported Providers:
- OpenAI API

Details:
- The project facilitates connecting to the OpenAI API for AI-powered features.
- Specific implementation details, authentication, and usage patterns would be found in the 'Open AI API' section under 'Features setup'.
```

--------------------------------

### Configure Heroku Environment Variables for GitHub Auth

Source: https://docs.lightningrails.com/features-setup/github-signup

Sets the GitHub API secret and ID as environment variables on Heroku for production authentication. Replace placeholders with your actual production API key and GitHub ID.

```shell
heroku config:set GITHUB_SECRET=YOUR_API_KEY
heroku config:set GITHUB_ID=YOUR_GITHUB_ID
```

--------------------------------

### Define UserMailer Welcome Method

Source: https://docs.lightningrails.com/features-setup/automatic-emails/editor

Implements the 'welcome' method within the UserMailer class. This method is responsible for constructing and sending a welcome email to a specified user.

```ruby
# app/mailers/user_mailer.rb
class UserMailer < ApplicationMailer
  def welcome(user)
    mail(to: user.email, subject: 'You are in :)')
  end
end
```

--------------------------------

### EmailLinks Controller Implementation

Source: https://docs.lightningrails.com/features-setup/magic-link-signup

Implements the `create` action to generate a magic link and send an email, and the `validate` action to verify the token and sign in the user.

```ruby
class EmailLinksController < ApplicationController
  skip_before_action :authenticate_user!

  def create
    @email_link = EmailLink.generate(params[:email])
    if @email_link
      flash[:notice] = "Access email sent! Please, check your inbox to enter"
      redirect_to root_path
    else
      flash[:alert] = "There was an error, please try again!"
      redirect_to new_user_session_path
    end
  end

  def validate
    email_link = EmailLink.where(token: params[:token]).where("expires_at > ?", DateTime.now).first

    unless email_link
      flash[:alert] = "Invalid or expired token!"
      redirect_to new_user_session_path
    end

    sign_in(email_link.user, scope: :user)
    flash[:notice] = "Welcome! You signed in successfully 🚀"
    redirect_to root_path
  end
end
```

--------------------------------

### DeepSeek Ruby API Wrapper using OpenAI Client

Source: https://docs.lightningrails.com/features-setup/open-ai-api

This Ruby class demonstrates how to initialize the OpenAI client to interact with the DeepSeek API. It configures the client with the DeepSeek access token and the correct base URI for the DeepSeek API endpoint.

```ruby
class DeepSeekApi
  def initialize
    @client = OpenAI::Client.new(access_token: ENV["DEEPSEEK_ACCESS_TOKEN"], uri_base: "https://api.deepseek.com/v1")
  end

  def analyze_product(product)
    chatgpt_response = @client.chat(parameters: {
      model: "deepseek-chat",
      messages: [
        { role: "system", content: "You are a product analyst expert..." },
        { role: "user", content: "Here is a product to analyze: #{product}..." }
      ]
    })
    chatgpt_response["choices"][0]["message"]["content"]
  end
end
```

--------------------------------

### Configure Cloudinary API Key

Source: https://docs.lightningrails.com/features-setup/images-and-media

Add your Cloudinary API credentials to the .env file to enable image processing and storage services. This is a crucial step for integrating Cloudinary into your application.

```env
CLOUDINARY_URL="cloudinary://<api_key>:<api_secret>@<cloud_name>"
```

--------------------------------

### UserMailer Welcome Email View

Source: https://docs.lightningrails.com/features-setup/automatic-emails/editor

The HTML template for the welcome email sent by UserMailer. It includes personalized content, links to documentation, and branding.

```html
<p>Hi!</p>

<p>Thank you for signing up to LightningRails. After <%= link_to "purchasing your first license", checkout_url %>  you will be able to download the boilerplate from the source repository and start building your app.</p>

<p>Visit the <a href="https://docs.lightningrails.com">documentation</a> to get started and learn how to implement the different features (authentication, payments, etc), how to use the different components, and how to deploy your app.</p>

<p>Cheers!</p>
<p>Dani, maker of LightningRails©</p>
```

--------------------------------

### Configure Cloudinary API Key

Source: https://docs.lightningrails.com/features-setup

Add your Cloudinary API credentials to the .env file to enable image processing and storage services. This is a crucial step for integrating Cloudinary into your application.

```env
CLOUDINARY_URL="cloudinary://<api_key>:<api_secret>@<cloud_name>"
```

--------------------------------

### Configure User Model for OmniAuthable

Source: https://docs.lightningrails.com/features-setup/github-signup

Enables the `omniauthable` module and specifies `:github` as a valid OmniAuth provider in the `User` model's Devise configuration.

```ruby
# models/user.rb
class User < ApplicationRecord
    # Include default devise modules. Others available are: 
    # :confirmable, :lockable, :timeoutable, :trackable

    devise :database_authenticatable, :registerable,
           :recoverable, :rememberable, :validatable,
           :omniauthable, omniauth_providers: [:github] # <- The new options
   # [...] 
 end
```

--------------------------------

### Configure DaisyUI Theme in LightningRails

Source: https://docs.lightningrails.com/getting-started/publish-your-docs

Modify your LightningRails application's theme by updating the `LIGHT_THEME` and `DARK_THEME` values in the `config/meta.yml` file. This allows easy customization of your project's branding using DaisyUI themes. Remember to restart your server after making changes.

```yaml
# config/meta.yml
LIGHT_THEME: "cupcake"
DARK_THEME: "forest"
```

--------------------------------

### Revert to Backup

Source: https://docs.lightningrails.com/resources

Restores the project to a previous state using Git checkout, useful for troubleshooting.

```shell
git checkout backup-before-update-[timestamp]
```

--------------------------------

### Create Multi-Provider LLM Service

Source: https://docs.lightningrails.com/features-setup/multi-provider-ai

Defines a service class to interact with an LLM, initializing with a specific model and providing methods for complex analysis tasks. It includes prompt engineering and message history management.

```ruby
# app/services/MultiProviderModels.rb
class MultiProviderModels
  def initialize
    @chat = RubyLLM.chat(model: "gpt-4o-mini") # pass the parameters here :)
  end

  def analyze_product(product)
    # Add a system prompt to give it context for better results.
    @chat.add_message role: :system, content: "You are a Product Hunt expert. Always include examples in your responses and explain them line by line."

    prompt = <<~PROMPT
      You are a product analyst expert specialized in evaluating digital products and services.
      You have deep knowledge of market trends, user experience, and business models.
      Your analysis should be structured, data-driven, and actionable.

      Here is a product to analyze: #{product}

      Please follow this process:
      1. Identify the key features and unique selling points
      2. Evaluate the market potential and target audience
      3. Analyze pricing strategy and business model
      4. Assess technical implementation and scalability
      5. Provide specific recommendations for improvement

      Format your response in clear sections with bullet points where appropriate.
      Be concise but thorough in your analysis.
    PROMPT

    @chat.ask(prompt)
  end
end
```

--------------------------------

### Revert to Backup

Source: https://docs.lightningrails.com/resources/updating-lightning-rails

Restores the project to a previous state using Git checkout, useful for troubleshooting.

```shell
git checkout backup-before-update-[timestamp]
```

--------------------------------

### Render Love Wall Testimonials Component in Ruby

Source: https://docs.lightningrails.com/ui-components/testimonials

Includes the Ruby ERB code to render the 'Love wall' testimonial component. This component is designed using HyperUI and adapted for DaisyUI. It requires the `components/testimonials` partial to be available.

```erb
<%= render "components/testimonials" %>
```

--------------------------------

### Switch Lightning Landing Theme

Source: https://docs.lightningrails.com/getting-started/lightning-landing/theme-and-branding

Demonstrates how to change the `data-theme` attribute in the `<body>` tag of `index.html` to switch between available DaisyUI themes for Lightning Landing pages. This allows for quick theme customization.

```html
<body data-theme="[theme-name]">
```

--------------------------------

### Rails Route for Product Analysis

Source: https://docs.lightningrails.com/features-setup/open-ai-api

Specifies how to define a route in a Ruby on Rails application's configuration file (`config/routes.rb`). This route maps incoming POST requests to the `/analyze_product` endpoint to the `analyze` action within the `ProductsController`.

```ruby
post "/analyze_product", to: "products#analyze"
```

--------------------------------

### Magic Link Signup API

Source: https://docs.lightningrails.com/features-setup/magic-link-signup

This section outlines the conceptual API for Magic Link Signup. It details the core requirement of an email for signup, bypassing traditional password management, and highlights the dependency on a configured transactional email service like Postmark.

```APIDOC
MagicLinkSignup:
  Purpose: Enable passwordless user authentication via email magic links.
  Requirements:
    - Transactional email service configured (e.g., Postmark).
  Process:
    1. User provides an email address.
    2. System sends a unique magic link to the provided email.
    3. User clicks the magic link to authenticate and log in.
  Benefits:
    - Increased signups by removing password friction.
    - Enhanced security through unique, time-limited links.
  Dependencies:
    - `features-setup/automatic-emails` guide for email setup.
    - `config/environments/development.rb` for development email delivery.
    - `config/environments/production.rb` for production email delivery.
```

--------------------------------

### Render Components in ERB View

Source: https://docs.lightningrails.com/getting-started/customize-the-views

Demonstrates rendering various partials (components) within an ERB view file. These partials likely represent different UI sections of the application.

```erb
<%= render "components/hero" %>
<%= render "components/featured_on" %>
<%= render "components/text_image" %>
<%= render "components/feature_tabs" %>
<%= render "components/price_cards" %>
<%= render "components/faq" %>
<%= render "components/cta_horizontal" %>
```

--------------------------------

### Generate Stimulus Wizard Controller

Source: https://docs.lightningrails.com/features-setup/multi-step-form-wizard

Command to generate a new Stimulus controller file for the wizard functionality using the Rails generator. This creates the basic file structure for the controller.

```shell
rails g stimulus wizard
```
Tokens:
Raw