Skip to content

Commit

Permalink
adds readme for docker files
Browse files Browse the repository at this point in the history
  • Loading branch information
nichlaes committed Jan 19, 2024
1 parent ac53829 commit 7f405e7
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Dockerized

This readme will explain the different docker files and what the purpose of those are.

## Folder Structure

- **client.dockerfile**: Dockerfile for building the client application container.
- **libms.dockerfile**: Dockerfile for building the library microservice container.
- **compose.dev.yml:** Docker Compose configuration for development environment.
- **compose.local.yml:** Docker Compose configuration for local installation.

## Running Docker Containers

Follow these steps to set up and run the application with docker.
### Prerequisites
- Docker: Install Docker on your machine.

### Build Docker Images
Navigate to the `/docker` folder in your terminal and build the Docker images.
**NB:** the docker images only needs to be build when using **development** environment.

```sh
docker-compose -f compose.dev.yml build
```

### Run Docker Compose

For development environment:

```bash
docker-compose -f compose.dev.yml up -d
```

For local environment:

```bash
docker-compose -f compose.local.yml up -d
```
### Access the Application
You should access the application through the PORT mapped to the Traefik container.
e.g. `localhost:9000`

0 comments on commit 7f405e7

Please sign in to comment.