https://github.com/guillaumebriday/rails-tailwindcss-starter

Rails 5.2 Starter project with Tailwindcss built in
https://github.com/guillaumebriday/rails-tailwindcss-starter

gitlab-ci minitest postgresql rails review-app rubocop starter tailwindcss webpack webpacker

Last synced: about 2 months ago
JSON representation

Rails 5.2 Starter project with Tailwindcss built in

• Host: GitHub
• URL: https://github.com/guillaumebriday/rails-tailwindcss-starter
• Owner: guillaumebriday
• License: mit
• Created: 2018-11-15T13:01:41.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-19T12:21:39.000Z (about 5 years ago)
• Last Synced: 2024-12-14T06:41:08.442Z (about 2 months ago)
• Topics: gitlab-ci, minitest, postgresql, rails, review-app, rubocop, starter, tailwindcss, webpack, webpacker
• Language: Ruby
• Homepage: https://rails-tailwindcss-starter.guillaumebriday.xyz
• Size: 692 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![build](https://gitlab.com/guillaumebriday/rails-tailwindcss-starter/badges/master/build.svg)](https://gitlab.com/guillaumebriday/rails-tailwindcss-starter/pipelines)

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/guillaumebriday)

# 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](https://github.com/rails/webpacker), [Tailwind CSS](https://tailwindcss.com), [Rubocop](https://github.com/rubocop-hq/rubocop) and [Docker](https://www.docker.com).

To create the app, I used this command:

```bash

$ 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

```bash

$ git clone [email protected]: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 :

```bash

$ 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](http://opensource.org/licenses/MIT) license.