Skip to content

Commit 71e9c87

Browse files
committed
docs: add docker info to readme.md
1 parent 2e1c0d5 commit 71e9c87

File tree

1 file changed

+35
-11
lines changed

1 file changed

+35
-11
lines changed

README.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,50 @@
22

33
This is a landing page for the [PHP Revival](https://github.com/php-revival/php-revival) browser extension.
44

5-
## Project setup with Vite
5+
## Development
6+
### Without Docker
7+
You'll need to have Node and NPM installed on your machine to run it locally.
68

7-
### Clone the repository
9+
#### Install Dependencies
10+
```bash
11+
npm i
12+
# or
13+
yarn
14+
```
815

16+
#### Watch File Changes
917
```bash
10-
git clone https://github.com/php-revival/php-revival.git
18+
npm run dev
19+
# or
20+
yarn dev
1121
```
1222

13-
### Install dependencies
23+
Navigate to `http://localhost:3000` to see your documentation.
1424

25+
### With Docker
26+
#### Build an image
27+
To build an image, navigate to the root of the project that contains `Dockerfile` and run this command:
1528
```bash
16-
npm install
17-
# or
18-
yarn
29+
docker compose build
1930
```
2031

21-
### Start the development server
32+
#### Run the container
33+
To run a container, navigate to the root of the project that contains `Dockerfile` and run this command:
34+
```bash
35+
docker compose up -d
36+
```
37+
38+
You can visit `http://localhost:3000` to see your documentation.
2239

40+
#### Enter the container
41+
To enter inside of the container, run this command:
2342
```bash
24-
npm run dev
25-
# or
26-
yarn dev
43+
docker exec -it php-revival-landing sh
44+
```
45+
46+
You'll be able to run NPM commands inside of the container.
47+
48+
#### Stop the container
49+
```bash
50+
docker compose down
2751
```

0 commit comments

Comments
 (0)