Skip to content

Commit 0467f8b

Browse files
committed
//
1 parent aa10cc1 commit 0467f8b

File tree

1 file changed

+70
-24
lines changed

1 file changed

+70
-24
lines changed

readme.md

Lines changed: 70 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
11
# AngularJS Demo Project
2+
23
This is a simple AngularJS demo project showcasing basic single-page application features including routing, data binding, and Material Design styling.
34

45
## 🔗 Live Demo
5-
You can view the live deployed version of this project here:
6-
https://ongunakaycom.github.io/angular-js-demo
6+
7+
You can view the live deployed version of this project here:
8+
\*\*[https://ongunakaycom.github.io/angular-js-demo/](https://ongunakaycom.github.io/angular-js-demo/)\*\*
79

810
---
11+
912
## 🚀 Deployment
10-
This project is automatically deployed to GitHub Pages using a GitHub Actions workflow. Every push to the `main` branch triggers a deployment pipeline that publishes the latest version to the `gh-pages` branch.
13+
14+
This project is automatically deployed to GitHub Pages using a GitHub Actions workflow. Every push to the \`main\` branch triggers a deployment pipeline that publishes the latest version to the \`gh-pages\` branch.
1115

1216
### CI/CD Workflow
13-
- Runs on every push to `main`
17+
18+
- Runs on every push to \`main\`
1419
- Builds the public directory from project files
15-
- Pushes content to `gh-pages` branch
16-
- Uses peaceiris/actions-gh-pages
17-
GitHub Actions config file: `.github/workflows/deploy.yml`
20+
- Pushes content to \`gh-pages\` branch
21+
- Uses [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages)
22+
23+
GitHub Actions config file: \`.github/workflows/deploy.yml\`
1824

1925
---
2026

2127
## 📁 Project Structure
28+
2229
```
23-
/
30+
├── .github/
31+
│ └── workflows/
32+
│ └── deploy.yml
33+
├── .gitignore
2434
├── about.html
2535
├── app.js
2636
├── cv.html
@@ -29,78 +39,114 @@ GitHub Actions config file: `.github/workflows/deploy.yml`
2939
├── readme.md
3040
└── style.css
3141
```
42+
3243
## 📄 File Descriptions
33-
- `index.html`: Main entry point of the application
34-
- `app.js`: AngularJS module and route configuration
35-
- `home.html`, `about.html`, `cv.html`: Different views for the single-page app
36-
- `style.css`: Custom CSS styles
37-
- `readme.md`: This project documentation
44+
45+
- \`index.html\`: Main entry point of the application
46+
- \`app.js\`: AngularJS module and route configuration
47+
- \`home.html\`, \`about.html\`, \`cv.html\`: Different views for the single-page app
48+
- \`style.css\`: Custom CSS styles
49+
- \`readme.md\`: This project documentation
50+
- \`.github/workflows/deploy.yml\`: GitHub Actions deployment configuration
51+
- \`.gitignore\`: Git ignore file for excluding files from version control
3852

3953
---
4054

4155
## ✨ Features
56+
4257
- AngularJS routing with ngRoute
4358
- Dynamic content loading based on views
4459
- Material Design styling with Angular Material
4560
- Responsive single-page application (SPA)
4661
- Lightweight and easy to understand codebase
62+
- Automated deployment to GitHub Pages
4763

4864
---
4965

5066
## 🧰 Prerequisites
67+
5168
- A modern web browser (Chrome, Firefox, Edge, etc.)
5269
- A simple HTTP server (Python, Node, etc.)
5370

5471
---
72+
5573
## 📦 Usage
74+
5675
### Option 1: Python HTTP Server
76+
5777
```bash
5878
cd path/to/angular-js-demo
5979
python3 -m http.server 8000
6080
```
61-
Access it at: `http://localhost:8000\`
81+
82+
Access it at: \`http://localhost:8000\`
83+
6284
### Option 2: Node.js Live Server
85+
6386
```bash
6487
npm install -g live-server
6588
cd path/to/angular-js-demo
6689
live-server
6790
```
91+
6892
### Option 3: Direct File Access
69-
Simply open `index.html` directly in your browser (note: routing may not work properly with this method).
93+
94+
Simply open \`index.html\` directly in your browser (note: routing may not work properly with this method).
95+
7096
---
97+
7198
## 🌐 Browser Compatibility
99+
72100
- Chrome 60+
73101
- Firefox 55+
74102
- Safari 12+
75103
- Edge 79+
104+
76105
---
106+
77107
## 🔧 Development
78108

79-
Clone the repository
80-
Modify files as needed
81-
Run locally using one of the server methods above
82-
Push changes to `main` to trigger auto-deployment
109+
1. Clone the repository
110+
2. Modify files as needed
111+
3. Run locally using one of the server methods above
112+
4. Push changes to \`main\` to trigger auto-deployment
83113

84114
---
115+
85116
## 🛠️ Technology Stack
86-
- **AngularJS** (1.8.2)
87-
- **Angular Material**
88-
- **ngRoute**
89-
- **HTML5**, **CSS3**
117+
118+
- \*\*AngularJS\*\* (1.8.2)
119+
- \*\*Angular Material\*\*
120+
- \*\*ngRoute\*\*
121+
- \*\*HTML5\*\*, \*\*CSS3\*\*
122+
- \*\*GitHub Actions\*\* (CI/CD)
123+
90124
---
125+
91126
## 📝 License
92-
This project is licensed under the **Apache-2.0 License**.
127+
128+
This project is licensed under the \*\*Apache-2.0 License\*\*.
129+
93130
---
131+
94132
## 👨‍💻 About Me
133+
95134
I'm **Ongun Akay**, a Senior Full-Stack Developer with expertise across various technologies.
135+
96136
- 👀 I specialize in full-stack development with deep frontend/backend skills
97137
- 🌱 Currently sharpening advanced web architecture and deployment practices
98138
- 💬 Reach out: info@ongunakay.com
139+
99140
---
141+
100142
## 🤝 Contributing
143+
101144
Pull requests, suggestions, and stars ⭐️ are always welcome!
145+
102146
---
147+
103148
## 📌 Changelog
149+
104150
- ✅ Initial release with SPA functionality
105151
- 🎨 Angular Material styling added
106152
- 🚀 GitHub Pages deployment with CI/CD

0 commit comments

Comments
 (0)