Skip to content

Commit 15090b4

Browse files
CodeByPinarCodeByPinar
authored
docs: add ultimate README with CI/CD diagram, badges and cloud links
- Added full production-ready README - Included GitHub Actions build badge, uptime badge and visitor counter - Added Mermaid-based CI/CD pipeline diagram - Documented live Render and Swagger endpoints - Enhanced project documentation for portfolio and showcase use
1 parent 874f769 commit 15090b4

1 file changed

Lines changed: 215 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
# 🚀 DotNet DevOps Pipeline
2+
3+
![.NET](https://img.shields.io/badge/.NET-8.0-purple)
4+
![Docker](https://img.shields.io/badge/Docker-Enabled-blue)
5+
![CI/CD](https://img.shields.io/badge/GitHub_Actions-CI/CD-yellow)
6+
![Cloud](https://img.shields.io/badge/Render-Cloud-success)
7+
![Status](https://img.shields.io/badge/Status-Production_Ready-brightgreen)
8+
![Build](https://img.shields.io/github/actions/workflow/status/CodeByPinar/DotnetDevopsPipeline/dotnet-ci.yml?branch=main)
9+
![Uptime](https://img.shields.io/uptimerobot/status/m792798342-6f5d4d0b75c5a7b)
10+
11+
![Visitors](https://komarev.com/ghpvc/?username=CodeByPinar\&repo=DotnetDevopsPipeline\&label=Visitors\&color=brightgreen)
12+
13+
<p align="left">
14+
<img height="170" src="https://github-readme-stats.vercel.app/api?username=CodeByPinar&show_icons=true&theme=radical&hide_border=true" />
15+
<img height="170" src="https://github-readme-streak-stats.herokuapp.com/?user=CodeByPinar&theme=radical&hide_border=true" />
16+
</p>
17+
18+
<p align="left">
19+
<img height="160" src="https://github-readme-stats.vercel.app/api/top-langs/?username=CodeByPinar&layout=compact&theme=radical&hide_border=true" />
20+
</p>
21+
22+
---
23+
24+
# 📌 Project Overview
25+
26+
**DotNet DevOps Pipeline** is a **fully automated production-ready CI/CD DevOps showcase project** built using **.NET 8, Docker, GitHub Actions, and Render Cloud**.
27+
28+
This project demonstrates how to build, test, containerize, and deploy a modern web API into a real production environment using professional DevOps workflows.
29+
30+
---
31+
32+
# 🌍 Live Production URLs
33+
34+
| Service | URL |
35+
| -------------- | ---------------------------------------------------------------------------------------------------------- |
36+
| ✅ Health Check | [https://dotnet-devops-pipeline.onrender.com/health](https://dotnet-devops-pipeline.onrender.com/health) |
37+
| 📘 Swagger UI | [https://dotnet-devops-pipeline.onrender.com/swagger](https://dotnet-devops-pipeline.onrender.com/swagger) |
38+
39+
---
40+
41+
# ⚡ CI/CD Pipeline Diagram (Mermaid)
42+
43+
```mermaid
44+
flowchart LR
45+
A[Git Push] --> B[GitHub]
46+
B --> C[GitHub Actions CI]
47+
C --> D[dotnet restore]
48+
D --> E[dotnet build]
49+
E --> F[dotnet test]
50+
F --> G[Docker Build]
51+
G --> H[Render Deploy]
52+
H --> I[Live Production API]
53+
```
54+
55+
---
56+
57+
# 📷 Application Screenshots
58+
59+
### ✅ Swagger UI (Production)
60+
61+
> *Replace this URL with your own screenshot later*
62+
63+
```txt
64+
https://dotnet-devops-pipeline.onrender.com/swagger
65+
```
66+
67+
---
68+
69+
### ✅ Render Live Deployment
70+
71+
```txt
72+
https://dotnet-devops-pipeline.onrender.com
73+
```
74+
75+
---
76+
77+
# 🧠 DevOps Automation Flow
78+
79+
```txt
80+
Push → CI → Test → Docker → Cloud → Live
81+
```
82+
83+
---
84+
85+
# 🏗️ Tech Stack
86+
87+
| Layer | Technology |
88+
| ---------- | -------------- |
89+
| Backend | .NET 8 Web API |
90+
| Logging | Serilog |
91+
| Containers | Docker |
92+
| CI/CD | GitHub Actions |
93+
| Cloud | Render |
94+
| Monitoring | Health Checks |
95+
| Docs | Swagger |
96+
97+
---
98+
99+
# ✨ Key Features
100+
101+
✅ Full DevOps lifecycle automation
102+
✅ Dockerized cloud-native API
103+
✅ Automated build, test, and deploy
104+
✅ Health monitoring & logging
105+
✅ Production deployment with zero downtime triggers
106+
107+
---
108+
109+
# 📂 Project Structure
110+
111+
```txt
112+
DotnetDevopsPipeline
113+
├─ DotnetDevopsPipeline.Api
114+
│ ├─ Controllers
115+
│ ├─ Program.cs
116+
│ ├─ Dockerfile
117+
│ ├─ appsettings.json
118+
│ └─ Properties
119+
├─ .github
120+
│ └─ workflows
121+
│ └─ dotnet-ci.yml
122+
├─ .gitignore
123+
└─ README.md
124+
```
125+
126+
---
127+
128+
# 🐳 Docker Usage (Local)
129+
130+
### Build Image
131+
132+
```bash
133+
docker build -t dotnetdevopspipeline .
134+
```
135+
136+
### Run Container
137+
138+
```bash
139+
docker run -p 8080:8080 dotnetdevopspipeline
140+
```
141+
142+
---
143+
144+
# ✅ Local Access
145+
146+
* Swagger: [http://localhost:8080/swagger](http://localhost:8080/swagger)
147+
* Health: [http://localhost:8080/health](http://localhost:8080/health)
148+
149+
---
150+
151+
# ⚙️ GitHub Actions CI/CD
152+
153+
Defined in `.github/workflows/dotnet-ci.yml`
154+
155+
### Triggered on
156+
157+
* Push to `main`
158+
* Pull Requests
159+
160+
### Pipeline Steps
161+
162+
* Restore
163+
* Build
164+
* Test
165+
* Docker Image Build
166+
* Auto Deploy to Render
167+
168+
---
169+
170+
# ☁️ Render Cloud Deployment
171+
172+
Uses Docker-based deployment with real-time health checks.
173+
174+
```
175+
ASPNETCORE_URLS=http://+:8080
176+
```
177+
178+
---
179+
180+
# 🔍 Health Check Endpoint
181+
182+
```http
183+
GET /health
184+
```
185+
186+
---
187+
188+
# 🏆 Career-Level Impact
189+
190+
✅ Demonstrates Production CI/CD expertise
191+
✅ Shows real DevOps toolchain usage
192+
✅ Proves cloud-native deployment skills
193+
194+
---
195+
196+
# 👨‍💻 Author
197+
198+
**CodeByPinar**
199+
[https://github.com/CodeByPinar](https://github.com/CodeByPinar)
200+
201+
---
202+
203+
# 🔮 Future Enhancements
204+
205+
* API Versioning
206+
* Authentication
207+
* Database Integration
208+
* Metrics Monitoring (Prometheus)
209+
* Distributed tracing
210+
211+
---
212+
213+
# ✅ License
214+
215+
MIT

0 commit comments

Comments
 (0)