Docker

TODO Add docker entrypoint that does initial npm install

We use Docker in development. This ensures a consistent development environment and allows for easy onboarding. Because everything is run and built using node from the same Docker container, there are no problems when developers are running different versions of node.

The build environment uses the same container as well, maintaining parity between all different environments.

Prerequisites

Make sure you have Docker installed: https://www.docker.com/products/docker-desktop

Starting up your environment

Checkout the project and

Simply run:

docker-compose up

and use Chrome to go to http://localhost:8000. This will show you the vue ui interface. Select the import tab, and then select current directory. You only need to import when you boot the container for the first time. In the event you are rebuilding your container you will have to click import again.

You can go to tasks and click serve. This will spin up the app at http://localhost:8080.

All running of npm tasks, adding dependencies, etc. should be done through the Vue UI interface.

Never run any commands, such as npm, on your local machine i.e. in the project directory on your machine

If there is something you cannot accomplish through the Vue UI interface and you need to run npm or some other command, log into the container and run your command there:

docker-compose exec ui sh

Any changes that result from executing your command within the container will be synced back to your machine, since there is a docker volume mounted.