Skip to content

Commit 43f81ca

Browse files
committed
Add detailed project overview and architecture explanation to README
1 parent e75192a commit 43f81ca

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@
33
## Project Overview
44
This project implements a cloud-hosted resume website using Azure Static Web Apps. The design focuses on simplicity, maintainability, and professional presentation.
55

6+
## Project Overview and Architecture
7+
8+
### Local Development Environment (Your Computer)
9+
We have your resume website code in the `Azure_Resume-new` folder. Inside this, we have a `frontend` folder with your HTML/JavaScript for the website, and a `backend` folder with our Function App code. The backend code includes the visitor counter logic that will talk to our database. When we make changes locally, we use Git to send these changes to GitHub.
10+
11+
### GitHub (Code Repository)
12+
GitHub acts as the central hub where all your code lives. It has two main jobs here: storing your code and deploying it. Through GitHub Actions (the workflow files in `.github/workflows`), it automatically takes your code and deploys it to Azure whenever you push changes. Think of GitHub as both a storage place and a delivery service - it stores your code and makes sure it gets to Azure properly.
13+
14+
### Azure Portal (Cloud Services)
15+
In Azure, we've set up two main services: a Cosmos DB (your database) to store the visitor count, and a Function App (your API) to manage the counter. The Function App runs the code from your backend folder to talk to the database. We've also set up "secrets" (connection strings and keys) in the Function App so it can securely connect to the database. When GitHub Actions deploys your code, it goes to this Function App.
16+
17+
The flow is: Local Changes → GitHub → Azure Portal. You make changes on your computer, push to GitHub, and GitHub automatically deploys them to Azure.
18+
619
## Live Website
720
- Production URL: [www.troymd.com](https://www.troymd.com)
821
- Azure URL: [jolly-flower-02175240f.5.azurestaticapps.net](https://jolly-flower-02175240f.5.azurestaticapps.net)

0 commit comments

Comments
 (0)