Skip to content

Latest commit

 

History

History
70 lines (57 loc) · 2.39 KB

README.md

File metadata and controls

70 lines (57 loc) · 2.39 KB
Raw

container-registry-playground

Trying out github's container registry and CI actions.

Images

Individual images are automatically published to linked Github Container Registries:

Development

Containers allow developers to separate the application's environment with the developer's environment. The most common example is adding a database - in the old days, if a developer wanted to run an app locally, they had to install and configure a database on their laptop. With docker, that's no longer the case... as long as you dockerize all components.

This repo provides an example setup for a full stack web app that can be developed without ever installing NodeJS on the host machine.

Starting a local instance.

docker-compose --file docker-compose.dev.yml up --build

You can access the app at localhost:8080. Locally changes to the source files will be instantly* reflected in the app.

Running unit tests

  • client/
docker-compose --file docker-compose.yml exec client npm test
  • server/
docker-compose --file docker-compose.yml exec server npm test

Linting / formatting source code.

  • client/
docker-compose --file docker-compose.yml exec client npm run lint
  • server/
TODO

Note that under the hood, you're running prettier.io on code located on your host machine, without ever explicitly installing prettier, Node, or any other tool but docker.

Any other command you wish to execute

docker-compose --file docker-compose.yml exec [client,server] <command>

How to use

Refer to docker-compose files.

Docker-compose files

Each docker-compose file contains a description on the very top. Below is a short list of available files.

docker-compose.yml

Spins up the app for local development. Tailored for quick builds and local code changes.

docker-compose.prod.yml

Starts the app optimized for production use.

docker-compose.test.yml

Allows running end-to-end tests with a single command. Note, that this file defines only test-specific services. It is meant to be ran on top of another docker-compose file. See docker-compose reference for details.