Skip to content

Commit be9df58

Browse files
committed
Updated the readme file
1 parent 11f8c92 commit be9df58

1 file changed

Lines changed: 46 additions & 10 deletions

File tree

readme.md

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,53 @@
1-
# Sample Node.js Project
1+
# 📦 Sample Node.js Application with Docker Support
22

3-
A Node.js project written using Express. EJS was used as the view engine.
3+
This repository contains a Node.js application packaged with Docker and managed via Docker Compose. It allows you to run the application in a containerized environment for easy setup and deployment.
44

5-
# Installation
5+
## 📁 Project Structure
6+
```
7+
├── app
8+
│ ├── public
9+
│ │ └── styles
10+
│ │ └── styles.css
11+
│ ├── routes.js
12+
│ └── server
13+
│ └── views
14+
│ └── index.ejs
15+
├── app.js
16+
├── docker-compose.yml
17+
├── Dockerfile
18+
├── package-lock.json
19+
├── package.json
20+
└── README.md
21+
```
22+
23+
24+
## 🚀 Getting Started
25+
26+
These instructions will get your application up and running using Docker.
27+
28+
### 🛠️ Prerequisites
29+
30+
Make sure you have the following installed:
31+
32+
- [Node.js](https://nodejs.org/) (for local development)
33+
- [Docker](https://www.docker.com/get-started)
34+
- [Docker Compose](https://docs.docker.com/compose/)
35+
36+
### 📦 Build and Run with Docker Compose
37+
38+
1. **Clone the repository**:
39+
40+
```bash
41+
git clone https://github.com/acemilyalcin/sample-node-project.git
42+
cd sample-node-project
43+
```
644

7-
You need to write the following commands on the terminal screen so that you can run the project locally.
45+
2. **Start application**
846

9-
```sh
10-
1. git clone git@github.com:acemilyalcin/sample-node-project.git
11-
2. cd sample-node-project
12-
3. npm install
13-
4. npm start
47+
```bash
48+
docker-compose up --build
1449
```
1550

51+
3. **Access the application**
1652

17-
The application is running on [localhost](http://localhost:3000).
53+
Once the containers are up, you can access the app at: [http://localhost:3000](http://localhost:3000)

0 commit comments

Comments
 (0)