Skip to content

Commit 15941ce

Browse files
committed
docs: add more info to docs
1 parent 67b5da8 commit 15941ce

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@
44
### Without Docker
55
You'll need to have Node and NPM installed on your machine to run it locally.
66

7+
#### Install Dependencies
8+
```bash
9+
npm i
10+
# or
11+
yarn
12+
```
13+
14+
#### Watch File Changes
15+
```bash
16+
npm run dev
17+
# or
18+
yarn dev
19+
```
20+
21+
Navigate to `http://localhost:5173` to see your documentation.
22+
723
### With Docker
824
#### Build an image
925
To build an image, navigate to the root of the project that contains `Dockerfile` and run this command:
@@ -17,7 +33,7 @@ To run a container, navigate to the root of the project that contains `Dockerfil
1733
docker compose up -d
1834
```
1935

20-
You can visit `localhost:3000` to see your documentation.
36+
You can visit `http://localhost:3000` to see your documentation.
2137

2238
#### Enter the container
2339
To enter inside of the container, run this command:

0 commit comments

Comments
 (0)