You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-7Lines changed: 31 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,42 +18,66 @@ npm run dev
18
18
Navigate to `http://localhost:3000` to see your documentation.
19
19
20
20
### With Container Engine
21
-
> [!NOTE]
22
-
> If you use [🐳 Docker](https://app.docker.com/) instead of [🦦 Podman](https://podman.io/), just replace `podman-compose` with `docker compose`, and `podman` with `docker` in code examples below.
23
-
24
21
#### Build an Image
25
-
To build an image, navigate to the root of the project and run this command:
22
+
To build an image, navigate to the root of the project and run this command. With Podman:
26
23
27
24
```bash
28
25
podman-compose build
29
26
```
30
27
28
+
With Docker:
29
+
30
+
```bash
31
+
docker compose build
32
+
```
33
+
31
34
#### Create `node_modules`
32
-
Run this command to install npm packages and generate a `node_modules` directory on your local machine:
35
+
Run this command to install npm packages and generate a `node_modules` directory on your local machine. With Podman:
33
36
34
37
```bash
35
38
podman-compose run --rm app npm i
36
39
```
37
40
41
+
With Docker:
42
+
```bash
43
+
docker compose run --rm app npm i
44
+
```
45
+
38
46
#### Run the Container
39
-
To run a container, navigate to the root of the project and run this command:
47
+
To run a container, navigate to the root of the project and run this command. With Podman:
40
48
41
49
```bash
42
50
podman-compose up -d
43
51
```
44
52
53
+
With Docker:
54
+
```bash
55
+
docker compose up -d
56
+
```
57
+
45
58
You can visit `http://localhost:3000` to see your documentation.
46
59
47
60
#### Enter the Container
61
+
With Podman:
48
62
```bash
49
63
podman-compose exec app sh
50
64
```
51
65
66
+
With Docker:
67
+
```bash
68
+
docker compose exec app sh
69
+
```
70
+
52
71
You'll be able to run NPM commands inside of the container.
53
72
54
73
#### Remove and Stop the Container
55
-
To stop and remove the container, run this command:
74
+
To stop and remove the container, run this command. With Podman:
0 commit comments