Skip to content

Commit 9b76579

Browse files
docs: update Docker usage instructions in README for improved clarity and add docker-compose support
1 parent ecabdec commit 9b76579

File tree

1 file changed

+17
-26
lines changed

1 file changed

+17
-26
lines changed

README.md

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
> <p>Prepare to excel in your CATs and FATs with CodeChef-VIT's dedicated repository of past exam papers. Access key resources to review concepts, tackle challenging questions, and familiarize yourself with exam patterns. Boost your confidence, sharpen your strategy, and get ready to ace your exams!</p>
88
99
## 🌐 Deploy
10+
1011
[https://papers.codechefvit.com](https://papers.codechefvit.com/)
1112

1213
## ⚙️ Tech Stack:
@@ -64,35 +65,25 @@ pnpm dev
6465

6566
## 🐳 Using Docker
6667

67-
### 1. Build the Image
68-
Run in the project root:
69-
```bash
70-
docker build -t papers-codechef .
71-
```
68+
To run the application using Docker, follow these steps:
7269

73-
### 2. Run the Container
74-
Start the app with:
75-
```bash
76-
docker run -p 3000:3000 papers-codechef
77-
```
78-
Access it at `http://localhost:3000`.
70+
1. **Build the Docker Image**:
7971

80-
### 3. Environment Variables
81-
Ensure `.env` is configured. Use `--env-file` to pass it:
82-
```bash
83-
docker run --env-file .env -p 3000:3000 papers-codechef
84-
```
72+
```bash
73+
docker build -t papers-codechef .
74+
```
8575

86-
### 4. Stop & Clean Up
87-
Stop the container:
88-
```bash
89-
docker ps
90-
docker stop <CONTAINER ID>
91-
```
92-
Remove the image:
93-
```bash
94-
docker rmi papers-codechef
95-
```
76+
2. **Run the Docker Container**:
77+
78+
```bash
79+
docker run -p 3000:3000 --env-file .env papers-codechef
80+
```
81+
82+
3. **Using Docker Compose**:
83+
If you prefer `docker-compose`, ensure the `docker-compose.yml` file is configured, then run:
84+
```bash
85+
docker-compose up
86+
```
9687

9788
Before getting started, please ensure that the .env file is properly configured. The .env.example file has been provided for your reference, with examples of environment variables to be listed.
9889

0 commit comments

Comments
 (0)