Skip to content

Commit 6a8258c

Browse files
authored
Enhance README with Quick Start and license badge
Added a Quick Start section and a license badge to the README.
1 parent ce78d4a commit 6a8258c

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# DevOps Starter Kit — FastAPI • Docker • CI/CD • Azure • Terraform
22

33
![CI/CD](https://github.com/devSharma31/devops-starter-kit/actions/workflows/ci-cd.yml/badge.svg?branch=main)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-lightgrey.svg)](LICENSE)
45

56
A **sandbox** project to demonstrate real DevOps skills safely and honestly for interviews.
67

@@ -24,6 +25,17 @@ A **sandbox** project to demonstrate real DevOps skills safely and honestly for
2425
2526
---
2627

28+
## Quick Start
29+
1. **Fork/clone** this repo.
30+
2. **Secrets (Repo → Settings → Secrets & variables → Actions):**
31+
- `AZURE_WEBAPP_NAME`, `AZURE_RESOURCE_GROUP`, `AZURE_PUBLISH_PROFILE` (or OIDC if you’ve set it up)
32+
3. **Run locally**:
33+
```bash
34+
uvicorn app.main:app --reload
35+
curl http://127.0.0.1:8000/health
36+
4. **Deploy: push to main. Check Actions → on success, browse https://<webapp-name>.azurewebsites.net/health.
37+
38+
---
2739
## Prereqs
2840
- Python **3.11+**
2941
- Git
@@ -171,7 +183,7 @@ Place all images in /evidence:
171183

172184

173185

174-
## 8) Extensions (great interview talking points)
186+
## 8) Extensions
175187

176188
- Deployment Slots + slot swap for zero-downtime rollouts
177189

0 commit comments

Comments
 (0)