Skip to content

Commit c3a2438

Browse files
committed
docs: update README with emojis and bullets
1 parent dbcf243 commit c3a2438

File tree

1 file changed

+43
-37
lines changed

1 file changed

+43
-37
lines changed

readme.md

Lines changed: 43 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
# AngularJS Portfolio Demo
1+
# 🌟 AngularJS Portfolio Demo
22

3-
A simple single-page portfolio website built with **AngularJS**, **ngRoute**, and **Angular Material**. It demonstrates routing, modular architecture, and dynamic data binding for a personal portfolio.
3+
A **simple single-page portfolio website** built with **AngularJS**, **ngRoute**, and **Angular Material**. This project demonstrates **routing**, **modular architecture**, and **dynamic data binding** for a personal portfolio.
44

55
---
66

7-
## Project Structure
7+
## 🗂 Project Structure
88

99
```
10-
1110
angular-js-demo/
1211
├── .github/
1312
│ └── workflows/
@@ -21,22 +20,29 @@ angular-js-demo/
2120
├── style.css # Main stylesheet
2221
├── LICENSE
2322
└── readme.md
24-
25-
````
23+
```
2624

2725
---
2826

29-
## Features
27+
## ⚡ Features
28+
29+
* 🚀 **Single-Page Application (SPA)** using AngularJS with **ngRoute** for client-side routing.
30+
* 📄 **Three main pages**:
31+
32+
* Home 🏠
33+
* About 👤
34+
* CV 📑
35+
* 🔄 **Dynamic content** rendered via AngularJS controllers:
3036

31-
- **SPA with AngularJS** using `ngRoute` for client-side routing.
32-
- **Three main pages**: Home, About, CV.
33-
- **Dynamic content** rendered via controllers (`HomeController`, `AboutController`, `CvController`).
34-
- **Responsive layout** using Angular Material design components.
35-
- **GitHub Pages deployment** automated with GitHub Actions.
37+
* `HomeController` – Manages welcome message
38+
* `AboutController` – Displays personal biography
39+
* `CvController` – Handles contact info, career objectives, qualifications, experience, and skills
40+
* 📱 **Responsive layout** using **Angular Material** design components.
41+
* 📦 **GitHub Pages deployment** automated with **GitHub Actions**.
3642

3743
---
3844

39-
## AngularJS App Overview
45+
## ⚙️ AngularJS App Overview
4046

4147
```javascript
4248
angular.module('cvApp', ['ngRoute', 'ngMaterial'])
@@ -47,26 +53,24 @@ angular.module('cvApp', ['ngRoute', 'ngMaterial'])
4753
.when('/cv', { templateUrl: 'cv.html', controller: 'CvController', controllerAs: 'cv' })
4854
.otherwise({ redirectTo: '/' });
4955
}]);
50-
````
51-
52-
* **HomeController**: Manages welcome message.
53-
* **AboutController**: Displays personal biography.
54-
* **CvController**: Handles contact info, career objectives, qualifications, experience, and skills.
56+
```
5557

5658
---
5759

58-
## Installation & Usage
60+
## 🏡 Installation & Usage
5961

60-
1. **Clone the repository**
62+
### Clone the repository
6163

6264
```bash
6365
git clone https://github.com/ongunakaycom/angular-js-demo.git
6466
cd angular-js-demo
6567
```
6668

67-
2. **Open `index.html`** in your browser (no server required for this static demo).
69+
### Open locally
6870

69-
3. **Optional: Run on a local server** (for routing support)
71+
* Simply open `index.html` in your browser (no server required for this static demo).
72+
73+
### Optional: Run on a local server (recommended for routing support)
7074

7175
```bash
7276
# Using Python
@@ -76,31 +80,33 @@ python -m http.server 8080
7680

7781
---
7882

79-
## Deployment
83+
## 🚀 Deployment
8084

81-
This project uses **GitHub Actions** to deploy to GitHub Pages automatically when changes are pushed to the `main` branch.
85+
This project uses **GitHub Actions** to deploy to **GitHub Pages** automatically when changes are pushed to the `main` branch.
8286

83-
Workflow: `.github/workflows/deploy.yml`
87+
**Workflow:** `.github/workflows/deploy.yml`
8488

85-
Key steps:
89+
**Key steps:**
8690

87-
1. Checkout repository.
88-
2. Copy project files to a `public` folder.
89-
3. Deploy contents of `public/` to GitHub Pages using `peaceiris/actions-gh-pages`.
91+
*Checkout repository
92+
* 📂 Copy project files to a public folder
93+
* 🌐 Deploy contents of `public/` to GitHub Pages using `peaceiris/actions-gh-pages`
9094

9195
---
9296

93-
## About Me
97+
## 👨‍💻 About Me
9498

95-
I'm Ongun Akay, a Senior Full-Stack Developer with expertise across various technologies.
99+
I'm **Ongun Akay**, a Senior Full-Stack Developer with expertise across various technologies.
96100

97-
* Website: [ongunakay.com](https://ongunakay.com)
98-
* GitHub: [github.com/ongunakaycom](https://github.com/ongunakaycom)
99-
* LinkedIn: [linkedin.com/in/ongunakay](https://linkedin.com/in/ongunakay)
100-
* Email: [info@ongunakay.com](mailto:info@ongunakay.com)
101+
* 🌐 Website: [ongunakay.com](https://ongunakay.com)
102+
* 💻 GitHub: [github.com/ongunakaycom](https://github.com/ongunakaycom)
103+
* 🔗 LinkedIn: [linkedin.com/in/ongunakay](https://linkedin.com/in/ongunakay)
104+
* ✉️ Email: [info@ongunakay.com](mailto:info@ongunakay.com)
101105

102106
---
103107

104-
## License
108+
## 📄 License
109+
110+
This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
105111

106-
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
112+
---

0 commit comments

Comments
 (0)