Skip to content

guillaumebriday/rails-tailwindcss-starter

Repository files navigation

build Donate

Rails Tailwind CSS Starter

The purpose of this repository is to provide you a head start to build your next Rails Application with Tailwind CSS pre-installed.

Introduction

This is a Rails 6.0 application with Webpacker, Tailwind CSS, Rubocop and Docker.

To create the app, I used this command:

$ rails new --webpack --skip-action-mailer --skip-action-cable --skip-sprockets --skip-spring  --skip-coffee --skip-turbolinks --skip-javascript --skip-bootsnap --database=postgresql .

Requirements in development environment

  • Rails
  • Ruby 2.6.3
  • Node.js and Yarn
  • Docker and Docker-Compose

Installation

$ git clone git@github.com:guillaumebriday/rails-tailwindcss-starter.git
$ cd rails-tailwindcss-starter
$ bundle install
$ yarn install
$ ./bin/webpack
$ docker-compose up -d
$ bundle exec rails db:setup
$ bundle exec rails s # or RUBYOPT="--jit" bundle exec rails s

Useful commands :

$ bundle exec rails test # or RUBYOPT="--jit" bundle exec rails test
$ bundle exec rubocop # or RUBYOPT="--jit" bundle exec rubocop

Now you can access the application on http://localhost:3000.

Deployment

I designed this application to setup and try Review Apps on Gitlab.

Contributing

Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.

License

This project is released under the MIT license.