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!

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

2. Enter the project directory:

   cd your_new_project_name
   

3. Run the configuration and setup scripts:

   bin/configure
   bin/setup
   

4. Boot your application:

   bin/dev
   

5. Visit https://localhost:3000.

Clicking this button will set up a new Bullet Train project for development on Gitpod.

Open-source development sponsored by:

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

Clicking this button will take you to the first step of a process that, when completed, will provision production-grade infrastructure for your Bullet Train application which will cost about $30/month.

When you're done deploying to Render, you need to go into "Dashboard" > "web", copy the server URL, and then go into "Env Groups" > "settings" and paste the URL into the value for BASE_URL.

Clicking this button will take you to the first step of a process that, when completed, will provision production-grade infrastructure and services for your Bullet Train application which will cost about $140/month.

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

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 [email protected]:your-account/bullet_train.git
   cd bullet_train
   

6. Run the setup script:

   bin/setup
   

7. Start the application:

   bin/dev
   

   [!NOTE] Optional: If you have ngrok installed, uncomment ngrok: ngrok http 3000 from Procfile.dev and run bin/set-ngrok-url to set BASE_URL to a publically accessible domain. Run bin/set-ngrok-url after restarting ngrok to update BASE_URL to the current public url.

8. Visit https://localhost:3000.

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