templates/README.md.erb in welaika-suspenders-2.31.0 vs templates/README.md.erb in welaika-suspenders-2.32.0
- old
+ new
@@ -1,18 +1,10 @@
# <%= app_name.humanize %>
## Getting Started
-After you have cloned this repo, run this setup script to set up your machine
-with the necessary dependencies to run and test this app:
-
- % ./bin/setup
-
-It assumes you have a machine equipped with Ruby, Postgres or MySQL, Node, Yarn and ImageMagick.
-
To install Ruby, read the [rbenv guide](https://github.com/rbenv/rbenv#installation)
-or the [rvm guide](https://rvm.io/rvm/install).
To install Postgres:
$ brew install postgresql@10
@@ -28,22 +20,26 @@
To install Yarn:
$ brew install yarn
-To install Chromedriver (for integration test):
-
- $ brew cask install chromedriver
-
To install ImageMagick (delete if not applicable):
$ brew install imagemagick@6
-After setting up, you can run the application using [Heroku Local](https://devcenter.heroku.com/articles/heroku-local):
+Now, clone this repo and you are ready to run the setup script:
+ % ./bin/setup
+
+You can run the application using [Heroku Local](https://devcenter.heroku.com/articles/heroku-local):
+
$ heroku local
+Run the quality checks and the tests suite:
+
+ $ rake
+
## Setup on Heroku (delete if not applicable):
### Database
https://elements.heroku.com/addons/heroku-postgresql
@@ -79,5 +75,21 @@
### Redis (if you need for Sidekiq):
https://elements.heroku.com/addons/heroku-redis
$ heroku addons:create heroku-redis:hobby-dev
+
+## Gitlab Docker Image
+
+We use a customer Docker image for our gitlab CI.
+
+You can read more about submitting a new image version [here](https://gitlab.com/welaika/<%= app_name %>/container_registry).
+
+Since our `Dockerfile` is called `Dockerfile.gitlab`, the commands are slightly different:
+
+
+```bash
+$ docker build -f Dockerfile.gitlab -t registry.gitlab.com/welaika/<%= app_name %> .
+$ docker push registry.gitlab.com/welaika/<%= app_name %>
+```
+
+Eventually, you can lint Dockerfiles with [hadolint](https://github.com/hadolint/hadolint)