🚀Quickstart

Quick demo

After accepting the Github Invite, Follow these three easy steps to quickly set up your new Ruby on Rails application using the Lightning Rails boilerplate.

If you doubt you have the correct Ruby on Rails Setup, you can refer to Le Wagon setup guide, one of the most complete.

Step 1: Clone the Repository

First, clone the Lightning Rails repository to your local machine. Open your terminal and run:

gh repo clone LightningRails/lightning-rails mysupercoolapp

If you are getting ERROR: Repository not found. fatal: Could not read from remote repository.

Make sure that you have accepted the Github Invitation on your email. Or that the github account in your terminal is the same you signed up with.

This creates a clone of the lightning rails repo, which is great! But we only want the source code, not the GitHub origin or all your code would be pushed to the Source repo 🫣

Let's fix it by removing the Origin and creating a new one...

Step 2: Run the setup script

After cloning the repository, navigate to the project directory:

cd mysupercoolapp

This 1 min script will ask you information about your project, if you don't have the data, don't worry, you can always go back and fill it in the meta.yml file.

bash generators/setup.sh

Step 3: Start the Server 🚀

Now you are ready to start your development server:

bin/dev

We use bin/dev instead of rails s so that Tailwind.css is compiled along with the server.

And that's it, enjoy the beautiful look of your new Rails app starter kit.