blob: 7e170e4bd1e840da1f76819d0f49ddcbbd19c41f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# Markr - Marking as a Service
**Szymon Szukalski's Submission to the Stile Coding Challenge - July 2024**
## Running the Project
This project uses Docker for building, testing, and running the application. Below are the instructions to incorporate
this project into your build system using Docker.
### Prerequisites
- Docker (version 20.10 or later)
- Docker Compose (version 1.29 or later)
### Build
To build the Docker image for the application, run the following command:
```shell
docker compose build
```
This command will build the application image using the Dockerfile defined in the project.
### Test
To run the tests using Docker, use the following command:
```shell
docker compose run --rm markr_tests
```
This command will build the Docker image (if not already built), start a container for testing, and run the tests. The
--rm flag ensures that the test container is removed after the tests complete.
### Run
To run the application, use the following command:
```shell
docker compose up postgres markr
```
This command will start the application and its dependencies (like PostgreSQL) as defined in the docker-compose.yml
file.
### Cleanup
To stop the running containers and remove them along with associated volumes, use:
```shell
docker compose down -v
```
This command will stop and remove the containers and any associated volumes.
|
