Suggested maintenance of readme and template

[oma-s]

This PR is meant for keeping the repo up to date. I updated the template and did some changes to the readme to reflect the current way we are handling the dev environment.

[justinallenmarsh]

I don't think we need to include the short hand in our docs. 🤔

[oma-s]

I can remove it. I felt it does not hurt to go a bit into detail though.

[justinallenmarsh]

this will not work on the projects that need postgres 15.

[oma-s]

that line has not changed. What change would you suggest?

[justinallenmarsh]

we don't use docker-compose on most projects at the moment.

[oma-s]

that is why I removed it in lines 92-97. As of Docker Compose V2 it uses the syntax below in line 11

[danieldiekmeier]

We don't use Docker Compose directly in the projects, but (at least for me) the development environment (Postgres, MySQL, Redis, Elasticsearch, etc) is running via Docker Compose the whole time. I assumed that's what these lines are referencing.

[justinallenmarsh]

we also dropped solar graph.

[justinallenmarsh]

postgres post should also be 54313

[justinallenmarsh]

This line should also be removed config.assets.paths << Rails.root.join("node_modules")

[justinallenmarsh]

We don't use solar graph anymore...

  plugins:
    - solargraph-standardrb
  reporters:
    - standardrb
YML```

[justinallenmarsh]

file ".env", <<~ENV
REDIS_URL=redis://127.0.0.1:6379

ease development with this puma settings

WEB_CONCURRENCY=0
PUMA_WORKER_TIMEOUT=6000
RAILS_MAX_THREADS=20
ENV

we don't user .env files for projects.

[justinallenmarsh]

file "package.json", <<~JS
{
"scripts": {
"format": "prettier --write \"src//*.{tsx,ts,scss,json}\"",
"lint": "yarn lint:types && yarn lint:style && yarn lint:format",
"lint:types": "tsc --noEmit",
"lint:style": "eslint app/javascript//.ts --max-warnings 0",
"lint:format": "prettier --list-different \"app/**/.{ts,scss,json}\"",
"build": "esbuild app/javascript/. --bundle --sourcemap --outdir=app/assets/builds",
"bundle-size": "npx source-map-explorer app/assets/builds/application.js app/assets/builds/application.js.map --no-border-checks",
"start": "yarn build --watch",
"live": "yarn livereload -e scss app/assets"
},
"license": "MIT"
}
JS

remove livereload as it doesnt' work.

[justinallenmarsh]

All the javascript files should use double quotes

[justinallenmarsh]

file ".github/workflows/ci.yml", <<~YML
name: CI
on: [push]
jobs:
ruby:
runs-on: ubuntu-20.04

  Update this to 22.04

[justinallenmarsh]

file "spec/support/system/cuprite_setup.rb", <<~RUBY

frozen_string_literal: true

require "capybara/cuprite"

Then, we need to register our driver to be able to use it later

with #driven_by method.

Capybara.register_driver(:cuprite) do |app|
Capybara::Cuprite::Driver.new(
app,
**{
window_size: [1200, 1400],
# See additional options for Dockerized environment in the respective section of this article
browser_options: {},
# Increase Chrome startup wait time (required for stable CI builds)
process_timeout: 10,
# Enable debugging capabilities
inspector: true,
# Allow running Chrome in a headful mode by setting HEADLESS env
# var to a falsey value
headless: Config.headless?
}
)
end

Config.headless?(default: true)

[justinallenmarsh]

run "yarn add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-prettier prettier livereload"

remove live reload

[danieldiekmeier]

Thank you! I think this is a good small set of changes to get the ball rolling. I personally would rather see this merged now than trying to fix every little thing at once.

[JensRavens]

no choice, use volta ;-)