[![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f?style=for-the-badge&logo=github)](https://github.com/Ruby-Starter-Kits/Docker-Rails-Template/generate)

# Rails App Welcome to your [Ruby On Rails](https://rubyonrails.org/) app. ## Setup & Running Locally Clone down the repo, install [Docker](https://hub.docker.com/editions/community/docker-ce-desktop-mac/) & run: ```bash $ ./bin/docker/setup $ ./bin/docker/start ``` This will build the docker image, then setup the `bin/setup` file which will run `bundle`, `yarn` & create the database. Then navigate your browser to https://127.0.0.1:3000/ to see your site. ### Running one of commands To run a one off command, run it within the web service, e.g: ```bash $ ./bin/docker/bundle exec rails db:migrate $ ./bin/docker/bundle $ ./bin/docker/yarn ``` ### Restoring a database If you have an existing database dump in a file called `latest.dump`, you can restore it by turning on just the postgres service in one terminal tab, and running `pg_restore` in a secondary tab: ```bash $ docker-compose up postgres $ pg_restore --verbose --clean --no-acl --no-owner -j 2 -h localhost -d App_development --username postgres latest.dump ``` ## Tests The template comes preconfigured with [RSpec](https://rspec.info/) for tests, and comes with a [GitHub Action](https://github.com/Ruby-Starter-Kits/Docker-Rails-Template/blob/master/.github/workflows/tests.yml) to run them when you push to GitHub. You can run RSpec locally by running: ```bash $ docker-compose -f docker-compose.ci.yml run --rm test ``` ## Linting This app uses [Standard](https://github.com/testdouble/standard) for Ruby and includes a [GitHub Action](https://github.com/Ruby-Starter-Kits/Docker-Rails-Template/blob/master/.github/workflows/standard.yml) to check future commits are up to standard. ## Contributing This was generated by [Ruby-Starter-Kits/Docker-Rails-Generator](https://github.com/Ruby-Starter-Kits/Docker-Rails-Generator), if you have any ideas please report them there :) ## Usage Feel free to use these as a starting point for your own Ruby on Rails project! ## Resources * [Ruby on Rails Guides](https://guides.rubyonrails.org/) * [Ruby on Rails API Documentation](https://api.rubyonrails.org/) * [Heroku](https://www.heroku.com/) * [Docker-Rails-Generator](https://github.com/Ruby-Starter-Kits/Docker-Rails-Generator) ## License [MIT](https://opensource.org/licenses/MIT) Copyright (c) 2020-present, [Mike Rogers](https://mikerogers.io/)