Suggested maintenance of readme and template #13
Conversation
| @@ -54,6 +58,10 @@ Then you will need to run this to install the ruby dependencies. | |||
|
|
|||
| bundle install | |||
|
|
|||
| Or for short just | |||
There was a problem hiding this comment.
I don't think we need to include the short hand in our docs. 🤔
There was a problem hiding this comment.
I can remove it. I felt it does not hurt to go a bit into detail though.
| @@ -89,12 +97,6 @@ If `bundle install` fails for the GEM `pg`, install `postgresql`: | |||
|
|
|||
| brew install postgresql | |||
There was a problem hiding this comment.
this will not work on the projects that need postgres 15.
There was a problem hiding this comment.
that line has not changed. What change would you suggest?
| @@ -6,7 +6,7 @@ This project contains all dependencies and services required by other nerdgescho | |||
|
|
|||
| ### Auto-Start Mode | |||
|
|
|||
| To have the environment start automatically when _Docker_ start, execute the following command once. | |||
| To have the environment start automatically when _Docker_ starts, execute the following command once. | |||
There was a problem hiding this comment.
we don't use docker-compose on most projects at the moment.
There was a problem hiding this comment.
that is why I removed it in lines 92-97. As of Docker Compose V2 it uses the syntax below in line 11
There was a problem hiding this comment.
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.
| @@ -61,7 +61,6 @@ | |||
| gem "rb-fsevent" | |||
| gem "letter_opener" | |||
| gem "debug" | |||
| gem "pry-rails" | |||
| gem "guard" | |||
| gem "guard-rspec" | |||
| gem "solargraph-standardrb" | |||
There was a problem hiding this comment.
postgres post should also be 54313
There was a problem hiding this comment.
This line should also be removed config.assets.paths << Rails.root.join("node_modules")
There was a problem hiding this comment.
We don't use solar graph anymore...
plugins:
- solargraph-standardrb
reporters:
- standardrb
YML```
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
All the javascript files should use double quotes
There was a problem hiding this comment.
file ".github/workflows/ci.yml", <<~YML
name: CI
on: [push]
jobs:
ruby:
runs-on: ubuntu-20.04
Update this to 22.04
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
run "yarn add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-prettier prettier livereload"
remove live reload
readme.md
Outdated
| @@ -34,6 +34,10 @@ You can check your ruby version by typing this in your project folder: | |||
|
|
|||
| If a version is not installed, you can add it by `rbenv install x.x.x`. | |||
|
|
|||
| ## node | |||
|
|
|||
| Make sure you have node installed. In order to do that use a version manager of your choice, such as [nvm](https://github.com/nvm-sh/nvm) or [volta](https://volta.sh/). | |||
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.