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
+7-27Lines changed: 7 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,24 +18,17 @@ npm run dev
18
18
Navigate to `http://localhost:3000` to see your documentation.
19
19
20
20
### With Container Engine
21
-
If you use a container engine like [🦦 Podman](https://podman.io/) or [🐳 Docker](https://app.docker.com/), here are the steps that you can make:
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.
22
23
23
24
#### Build an Image
24
-
To build an image, navigate to the root of the project and run this Docker command:
25
-
```bash
26
-
docker compose build
27
-
```
28
-
For Podman, run this:
25
+
To build an image, navigate to the root of the project and run this command:
29
26
```bash
30
27
podman-compose build
31
28
```
32
29
33
30
#### Copy `node_modules` Locally
34
-
If you need to copy `node_modules` directory from the container to your local machine, run this command for Docker:
35
-
```bash
36
-
docker cp php-revival-landing:/app/node_modules .
37
-
```
38
-
For Podman, run this:
31
+
If you need to copy `node_modules` directory from the container to your local machine, run this command:
> `node_modules` is excluded from using volume in [compose.yml](compose.yml) file, that's why you need to copy it manually. It's done to prevent your local modules to be copied to Linux container, since it can create incompatibility issues between operating systems if you don't use Linux.
45
38
46
39
#### Run the Container
47
-
To run a container, navigate to the root of the project and run this Docker command:
48
-
```bash
49
-
docker compose up -d
50
-
```
51
-
For Podman, run this:
40
+
To run a container, navigate to the root of the project and run this command:
52
41
```bash
53
42
podman-compose up -d
54
43
```
55
44
56
45
You can visit `http://localhost:3000` to see your documentation.
57
46
58
47
#### Enter the Container
59
-
To enter inside of the container, run this Docker command:
60
-
```bash
61
-
docker compose exec app sh
62
-
```
63
-
For Podman, run this:
64
48
```bash
65
49
podman-compose exec app sh
66
50
```
67
51
68
52
You'll be able to run NPM commands inside of the container.
69
53
70
-
#### Remove the Container
71
-
To stop and remove the container, run this Docker command:
72
-
```bash
73
-
docker compose down
74
-
```
75
-
For Podman, run this:
54
+
#### Remove and Stop the Container
55
+
To stop and remove the container, run this command:
0 commit comments