Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 46 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,53 @@
# Sample Node.js Project
# 📦 Sample Node.js Application with Docker Support

A Node.js project written using Express. EJS was used as the view engine.
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.

# Installation
## 📁 Project Structure
```
├── app
│ ├── public
│ │ └── styles
│ │ └── styles.css
│ ├── routes.js
│ └── server
│ └── views
│ └── index.ejs
├── app.js
├── docker-compose.yml
├── Dockerfile
├── package-lock.json
├── package.json
└── README.md
```


## 🚀 Getting Started

These instructions will get your application up and running using Docker.

### 🛠️ Prerequisites

Make sure you have the following installed:

- [Node.js](https://nodejs.org/) (for local development)
- [Docker](https://www.docker.com/get-started)
- [Docker Compose](https://docs.docker.com/compose/)

### 📦 Build and Run with Docker Compose

1. **Clone the repository**:

```bash
git clone https://github.com/acemilyalcin/sample-node-project.git
cd sample-node-project
```

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

```sh
1. git clone git@github.com:acemilyalcin/sample-node-project.git
2. cd sample-node-project
3. npm install
4. npm start
```bash
docker-compose up --build
```

3. **Access the application**

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