bullet_train

# Bullet Train Application Template
If you're new to Bullet Train, start with the [Bullet Train Developer Documentation](https://bullettrain.co/docs) and the [Getting Started](https://bullettrain.co/docs/getting-started) guide. You should also [join the community Discord server](https://discord.gg/bullettrain)!

## Prerequisites

### On macOS

If you haven't already, install [Homebrew](https://brew.sh). We'll use it later to automatically install other dependencies, including:

 - [rbenv](https://github.com/rbenv/rbenv) and [ruby-build](https://github.com/rbenv/ruby-build) for Ruby version management
 - [nvm](https://github.com/nvm-sh/nvm) and [Yarn](https://yarnpkg.com) for Node version and package management
 - [PostgreSQL](https://www.postgresql.org) as a relational database
 - [Redis](https://redis.io) for Action Cable WebSockets and background job queues


## Building a New Application with Bullet Train

If you're building a new application with Bullet Train, you don't want to "Fork" the template repository on GitHub. Instead, you should:

1. Clone the template repository:

    ```
    git clone https://github.com/bullet-train-co/bullet_train.git your_new_project_name
    ```

2. Enter the project directory:

    ```
    cd your_new_project_name
    ```

4. If you're on macOS, you can use [Homebrew](https://brew.sh) to install all dependencies:

    ```
    brew bundle
    ```

    Unfortunately when you install dependencies this way, Homebrew suppresses the additional set up instructions, so we've included those below.

    ### Additional nvm configuration

    If Homebrew is installing nvm for the first time, there are some additional steps you need to take:

    ```
    mkdir ~/.nvm
    touch ~/.zshrc
    open ~/.zshrc
    ```

    When the editor opens, paste the following into `~/.zshrc` and save:

    ```
    export NVM_DIR="$HOME/.nvm"
    [ -s "/opt/homebrew/opt/nvm/nvm.sh" ] && \. "/opt/homebrew/opt/nvm/nvm.sh"
    [ -s "/opt/homebrew/opt/nvm/etc/bash_completion.d/nvm" ] && \. "/opt/homebrew/opt/nvm/etc/bash_completion.d/nvm"
    ```

    ### Additional rbenv configuration

    If Homebrew is installing rbenv for the first time, there are some additional steps you need to take:

    ```
    rbenv init
    rbenv install `cat .ruby-version`
    ```

    > ⚠️ You'll need to open a new shell before continuing. The easiest way to do this on macOS is hitting `⌘` + `T` to open a new tab in the same working directory.   

    ### Additional PostgreSQL configuration

    If Homebrew is installing PostgreSQL for the first time, there are some additional steps you need to take:

    ```
    brew services start postgresql@14
    ```

    ### Additional Redis configuration

    If Homebrew is installing Redis for the first time, there are some additional steps you need to take:

    ```
    brew services start redis
    ```

6. Make sure Node.js is properly confi