Skip to content

Commit fafc33a

Browse files
authored
Update README.md
1 parent 1be020f commit fafc33a

File tree

1 file changed

+37
-6
lines changed

1 file changed

+37
-6
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,39 @@
1-
# Node JS demo App
1+
# Node.js CI/CD Demo App πŸš€
22

3-
> The article tutorial about building this NodeJS app demo and the various way to deploy it, is plublished on my medium blog here:
3+
This is a sample Node.js application with a fully automated **CI/CD pipeline** using **GitHub Actions** and **DockerHub**.
44

5-
* [How to Build and Run a NodeJS app with Docker & GitHub Actions CI/CD](https://blog.devgenius.io/how-to-build-and-run-a-nodejs-app-with-docker-github-actions-59eb264dfef5)
6-
* [How to Deploy to Kubernetes & Heroku using Docker](https://blog.devgenius.io/how-to-deploy-to-kubernetes-heroku-using-docker-c2556a9584df)
7-
* [Deploying to GPC using Docker, Kubernetes, Terraform, and GitHub Actions CI/CD](https://blog.devgenius.io/how-to-provision-configure-deploy-to-google-cloud-platform-97dbbe36fcde "https://blog.devgenius.io/how-to-provision-configure-deploy-to-google-cloud-platform-97dbbe36fcde")
8-
updated to test Github actions
5+
## Overview
6+
7+
This project demonstrates how to:
8+
- Build and test a Node.js application
9+
- Automatically build a Docker image
10+
- Push the Docker image to DockerHub
11+
- Trigger the entire workflow on every push to the `main` branch
12+
13+
## πŸ”§ Tech Stack
14+
15+
- Node.js
16+
- GitHub Actions
17+
- Docker & DockerHub
18+
19+
## CI/CD Workflow Summary
20+
21+
The GitHub Actions workflow does the following:
22+
23+
1. πŸ“₯ Checkout the repository
24+
2. βš™οΈ Set up Node.js environment
25+
3. πŸ“¦ Install project dependencies
26+
4. βœ… Run unit tests (`npm test`)
27+
5. πŸ—οΈ Build the Node.js app
28+
6. 🐳 Build Docker image
29+
7. πŸ” Login to DockerHub using GitHub Secrets
30+
8. πŸš€ Push image to DockerHub repository
31+
32+
## Docker Image
33+
34+
You can find the built Docker image here:
35+
36+
πŸ‘‰ **[DockerHub Repo Link](https://hub.docker.com/r/kishxrx/nodejs-demo-app)**
37+
*(Replace with your actual DockerHub link)*
38+
39+
## πŸ“‚ File Structure

0 commit comments

Comments
Β (0)