HeartJiBoy / bullet_train

The Open Source Ruby on Rails SaaS Framework

Bullet Train Application Template

If you're new to Bullet Train, start with the Bullet Train Developer Documentation and the Getting Started guide. You should also join the community Discord server!

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 [e-mail]:bullet-train-co/bullet_train.git your_new_project_name
   

2. Enter the project directory:

   $ cd your_new_project_name
   

3. Run the configuration script:

   $ bin/configure
   

Open-source development sponsored by:

Provisioning a Production Environment on Heroku

You can use this public repository to provision a new application on Heroku and then push your private application code there later.

Once that process has completed, be sure to complete the other steps from the Deploying to Heroku documentation.

Contribute to Bullet Train

If you're looking contribute to Bullet Train, you should "Fork" this template repository on GitHub, like so:

1. Visit https://github.com/bullet-train-co/bullet_train.

2. Click "Fork" in the top-right corner.

3. Select the account where you want to fork the repository.

4. Click the "Code" button on the new repository and copy the SSH path.

5. Clone your forked repository using the SSH path you copied, like so:

   $ git clone [e-mail]:your-account/bullet_train.git
   $ cd bullet_train
   

6. Run the setup script:

   $ bin/setup
   

7. Start the application:

   $ bin/dev
   

8. Visit http://localhost:3000.

---

This README.md file will be replaced with README.example.md after running bin/configure.