Improve local development and startup via docker

[MrPandir]

Motivation

• Ensuring an easier start for new contributors.
• Avoiding the need to install necessary development tools on the local system.
• Ensuring the project runs in the same environment, eliminating potential issues associated with the system environment.

Purposes

• Add the ability to run a project locally in docker compose.
• Add dev container support.
• Document this in the README.

Known bugs

• An error may occur when launching an app container if the database was not ready to accept requests.
  This often happens if the volume does not exist, in which case the container needs additional time to create the volume.
  Solution: add a health check for the database container.

• Dev container fails at build.
  Cause: dev container tries to override the configuration and fails.

  Logs

   [2024-06-15T19:18:33.904Z] Docker Compose override file for building image:
   services:
     app:
       build:
         dockerfile: /var/folders/gz/srd0zmvj357gnb8_lk28mj400000gn/T/devcontainercli/container-features/0.64.0-1718479113903/Dockerfile-with-features
         args:
           - BUILDKIT_INLINE_CACHE=1
           - _DEV_CONTAINERS_BASE_IMAGE=dev_container_auto_added_stage_label
   
   [2024-06-15T19:18:33.924Z] Start: Run: docker-compose --project-name dudes -f /Users/user/Desktop/dudes/compose-dev.yaml -f /Users/user/Library/Application Support/Code - Insiders/User/globalStorage/ms-vscode-remote.remote-containers/data/docker-compose/docker-compose.devcontainer.build-1718479113904.yml -f /Users/user/Library/Application Support/Code - Insiders/User/globalStorage/ms-vscode-remote.remote-containers/data/docker-compose/docker-compose.devcontainer.containerFeatures-1718479113923-c8851d69-5ce9-45d0-b5cc-8dc9b122edb3.yml up -d --no-recreate
   [2024-06-15T19:18:33.973Z] service "app" declares mutualy exclusive dockerfile and dockerfile_inline: invalid compose project
  

• When opening http://localhost:4300/client on the server, you can’t find the user.
  Not sure if this error is related to deployment. Maybe you need to run pnpm run db:generate.
  Update: This is not a deployment issue.

  Logs

  client_prisma_error.log

• There is no mounting of the volume with project files in the app container.
  Currently, the project is copied during the creation of the image container.

Addition

At the moment, I can't ensure that the project works correctly in docker compose because the Twitch console refuses to register a new application due to the link not corresponding to the https protocol, even for links that have the https protocol.
It may be worth adding nginx to docker compose for development, which will allow testing some things locally.

[MrPandir]

Development in Docker is already working. But this is not yet documented in the README.
And there is still the problem of creating the database for the first time. It is worth adding a database health check and only then launching the app service.

[MrPandir]

Basically this is the finished stage.
But I would like to add nginx. I was able to add nginx and run it, but it requires me to change the nginx/default.conf file as it has all ports set to 3000. 🤔

[inferst]

I left some comments. Thank you for interest in the project. I appreciate it.

[inferst]

It would be better if we don't change current compose filenames. Also for local TS development it's not necessary to have the whole application inside a container. I suggest delete app part or create new compose file specifically for dev containers.

[MrPandir]

It would be better if we don't change current compose filenames.

I think otherwise, it's worth changing for these reasons:

• Shorter name is easier to type
• Follows modern Docker Compose naming conventions
• Reduces potential for typos

Also for local TS development it's not necessary to have the whole application inside a container. I suggest delete app part or create new compose file specifically for dev containers.

My interpretation of what you are suggesting:

• .devcontainer/compose.app.yaml - сontains the project
• compose.db.yaml - сontains only postgres

I also want to add nginx to the development environment so that I can test things like 7tv emotes that require a proxy.
It also brings you closer to the production environment, which helps identify potential problems early on.
This will add one more file:

• compose.nginx.yaml - сontains only nginx

I can do that. Is that okay with you?

[inferst]

I think otherwise, it's worth changing for these reasons:

Shorter name is easier to type
Follows modern Docker Compose naming conventions
Reduces potential for typos

It makes sense, but if we want to rename compose files we should also rename docker-compose.production.yml. I would like to avoid inconsistency. Either we rename all files or leave it as is and rename them in separate branch.

My interpretation of what you are suggesting:
.devcontainer/compose.app.yaml - сontains the project

Looks good.

compose.db.yaml - сontains only postgres

Let's leave dev or development. Potentially it can contain other services for dev environment.

I also want to add nginx to the development environment so that I can test things like 7tv emotes that require a proxy.

My suggestion is place nginx config for 7tv proxy to the dev compose file. But only proxy.

[MrPandir]

It makes sense, but if we want to rename compose files we should also rename docker-compose.production.yml. I would like to avoid inconsistency.

I want to rename docker-compose.production.yaml to compose.prod.yaml, but this PR should not affect the production environment.

Either we rename all files or leave it as is and rename them in separate branch.

So yes, it's worth doing this in a separate PR in which to rename all the files.

Let's leave dev or development. Potentially it can contain other services for dev environment.
My suggestion is place nginx config for 7tv proxy to the dev compose file. But only proxy.

I thought about that, but would you be happy with posgres and nginx running in the same file?

Changed structure:

.
├── .devcontainer/
│   └── compose.app.yaml ─ project
├── compose.dev.yaml ─ posgres and nginx
└── compose.prod.yaml ─ no changes :D

[inferst]

Let's leave dev or development. Potentially it can contain other services for dev environment.
My suggestion is place nginx config for 7tv proxy to the dev compose file. But only proxy.

I thought about that, but would you be happy with posgres and nginx running in the same file?

If I could serve app locally with pnpm run dev I would be happy :D

So yes, it's ok

[MrPandir]

• Add some VS_Сode extensions to devcontainer.
• Add pnpm run db:seed execution to devcontainer.
• Move README style changes to a separate PR, leaving only those related to devcontainer and docker.
• Add container with nginx.
• Do not migrate when the container starts. Execute when creating a container.
• Is it possible to add caching for devcontainer files? Because the startup is too long, by my standards.
• Move app service to compose.dev.app.yaml.
• Mount global git config in read-only mode.
• Add a connection description for viewing the database.
• Add information about adding extensions via defaultExtensions.

[MrPandir]

Added nginx and website to the compose file. This now looks like the production version, except that it is running in dev mode.
nginx will also be able to proxy requests if the project is run locally, since it uses the host machine environment.

nginx works on port 8080, to make twitch application authorization work, it should be added to the list of allowed redirect urls.

@inferst do it please.

[inferst]

This PR is getting more complicated than I expected. It takes time to find out what happens.

Again, for me it's not convenient to have the whole app in dev container.

[MrPandir]

Again, for me it's not convenient to have the whole app in dev container.

I'm still working on it. It's the next thing I intend to do.

I'm turning PR back into draft until it's in the final stages. As soon as it works as intended and satisfies everyone and is fully documented in the README, I will reopen it for merging.

[MrPandir]

• Replace docker compose run with docker compose up