Fix up Docker config and README instructions so setting up the project via Docker works once again

matyikriszta commented 1 month ago

Description

Installing the application via Docker (the recommended method in the README) hasn't been working for a while. This PR updates the Docker config and the README to ensure installing the project via Docker works once again.

Changes made:

Installs chromium into Docker image to run js tests in the container. We prefer this approach to emulating a different architecture because emulating a diff architecture is slow (as per #1900).
Removes deprecated version key from docker-compose.yml
Reworks the commands in bin/ so their name reflects the docker-compose commands they call
Updates the Docker installation instructions in the README, adding the missing step (starting the docker container and running the Rails server are two separate steps now).

Status

Ready for Review

Screenshots

N/A

Shout out to @BPScott for a massive assist with this.

matyikriszta commented 1 month ago

@biggianteye would you be able to review this PR for us?

MichalSmyk commented 1 month ago

bin/dup throws bin/dup: line 5: docker-compose: command not found

biggianteye commented 1 month ago

@biggianteye would you be able to review this PR for us?

Yep. Will do.

biggianteye commented 1 month ago

On my Intel Mac, following the README, I was able to successfully do the following:

Build the docker image and set up the application.
Have a running web application.
Run the tests.

On my M1 Mac I wasn't able to finish installing the Ruby dependencies, but I think that's still a separate issue that's unrelated to this PR.

error output

``` rake aborted! LoadError: /usr/local/bundle/gems/msgpack-1.7.2/lib/msgpack/msgpack.so: cannot open shared object file: No such file or directory - /usr/local/bundle/gems/msgpack-1.7.2/lib/msgpack/msgpack.so (LoadError) :37:in `require' :37:in `require' /usr/local/bundle/gems/msgpack-1.7.2/lib/msgpack.rb:7:in `' :37:in `require' :37:in `require' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap/load_path_cache/store.rb:5:in `block in ' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap/explicit_require.rb:45:in `rescue in with_gems' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap/explicit_require.rb:41:in `with_gems' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap/load_path_cache/store.rb:5:in `' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap/load_path_cache.rb:77:in `require_relative' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap/load_path_cache.rb:77:in `' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap.rb:5:in `require_relative' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap.rb:5:in `' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap/setup.rb:3:in `require_relative' /usr/local/bundle/gems/bootsnap-1.18.3/lib/bootsnap/setup.rb:3:in `' :37:in `require' :37:in `require' /planner/config/boot.rb:4:in `' /planner/config/application.rb:1:in `require_relative' /planner/config/application.rb:1:in `' /planner/rakefile:4:in `require_relative' /planner/rakefile:4:in `' /usr/local/bundle/gems/rake-13.1.0/exe/rake:27:in `' ```

In my eyes, this PR does what it intends by making sure the Docker instructions are up to date.

biggianteye commented 1 month ago

bin/dup throws bin/dup: line 5: docker-compose: command not found

It looks like docker-compose is no longer provided as a separate command out of the box. It can be installed as a separate package. Though the functionality has been built into the main docker binary for a while now (via docker compose).

MichalSmyk commented 1 month ago

bin/dup throws bin/dup: line 5: docker-compose: command not found

It looks like docker-compose is no longer provided as a separate command out of the box. It can be installed as a separate package. Though the functionality has been built into the main docker binary for a while now (via docker compose).

Not sure what the issue was, I don't really work with docker on daily basis. I did docker compose up first and then I was able to do bin/dserver and run the app.

matyikriszta commented 1 month ago

@biggianteye updated docker-command to docker command everywhere we use it. @MichalSmyk this should fix your issue as well. If you do bin/ddown (to destroy the container) and then do bin/dup again it should run without issue. Let me know if it works.

MichalSmyk commented 1 month ago

@matyikriszta looks good now, no issues. Thanks for sorting it out

codebar / planner