Skip to content

Commit 9c405e1

Browse files
committed
//
1 parent a4bfb1b commit 9c405e1

File tree

1 file changed

+68
-80
lines changed

1 file changed

+68
-80
lines changed

readme.md

Lines changed: 68 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# AngularJS Demo Project
2-
32
This is a simple AngularJS demo project showcasing basic single-page application features including routing, data binding, and Material Design styling.
4-
5-
## Project Structure
6-
3+
## 🔗 Live Demo
4+
You can view the live deployed version of this project here:
5+
**https://ongunakaycom.github.io/angular-js-demo/**
6+
---
7+
## 🚀 Deployment
8+
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.
9+
### CI/CD Workflow
10+
- Runs on every push to `main`
11+
- Builds the public directory from project files
12+
- Pushes content to `gh-pages` branch
13+
- Uses peaceiris/actions-gh-pages
14+
GitHub Actions config file: `.github/workflows/deploy.yml`
15+
---
16+
## 📁 Project Structure
717
```
818
/
919
├── about.html
@@ -14,95 +24,73 @@ This is a simple AngularJS demo project showcasing basic single-page application
1424
├── readme.md
1525
└── style.css
1626
```
17-
18-
## File Descriptions
19-
20-
- `index.html\`: Main entry point of the application
21-
- `app.js\`: AngularJS module and route configuration
22-
- `home.html\`, \`about.html\`, \`cv.html\`: Different views for the single page app
23-
- `style.css\`: Custom CSS styles
24-
- `readme.md\`: This project documentation
25-
26-
## Features
27-
27+
## 📄 File Descriptions
28+
- `index.html`: Main entry point of the application
29+
- `app.js`: AngularJS module and route configuration
30+
- `home.html`, `about.html`, `cv.html`: Different views for the single-page app
31+
- `style.css`: Custom CSS styles
32+
- `readme.md`: This project documentation
33+
---
34+
## ✨ Features
2835
- AngularJS routing with ngRoute
2936
- Dynamic content loading based on views
3037
- Material Design styling with Angular Material
31-
- Simple navigation menu
32-
- Responsive design
33-
- Single Page Application (SPA) architecture
34-
35-
## Prerequisites
36-
37-
- Modern web browser with JavaScript enabled
38-
- Basic HTTP server (for proper routing functionality)
39-
40-
## Installation & Usage
41-
42-
### Method 1: Python HTTP Server
43-
38+
- Responsive single-page application (SPA)
39+
- Lightweight and easy to understand codebase
40+
---
41+
## 🧰 Prerequisites
42+
- A modern web browser (Chrome, Firefox, Edge, etc.)
43+
- A simple HTTP server (Python, Node, etc.)
44+
---
45+
## 📦 Usage
46+
### Option 1: Python HTTP Server
4447
```bash
4548
cd path/to/angular-js-demo
4649
python3 -m http.server 8000
4750
```
48-
49-
Then open your browser at `http://localhost:8000`
50-
51-
### Method 2: Node.js Live Server
52-
51+
Access it at: `http://localhost:8000\`
52+
### Option 2: Node.js Live Server
5353
```bash
5454
npm install -g live-server
5555
cd path/to/angular-js-demo
5656
live-server
5757
```
58-
59-
### Method 3: Direct File Access
60-
61-
Simply open \`index.html\` directly in your browser (note: routing may not work properly with this method).
62-
63-
## Browser Compatibility
64-
65-
This project is compatible with:
58+
### Option 3: Direct File Access
59+
Simply open `index.html` directly in your browser (note: routing may not work properly with this method).
60+
---
61+
## 🌐 Browser Compatibility
6662
- Chrome 60+
6763
- Firefox 55+
6864
- Safari 12+
6965
- Edge 79+
70-
71-
## Development
72-
73-
To modify or extend this project:
74-
75-
1. Clone or download the repository
76-
2. Make your changes to the respective files
77-
3. Test using one of the server methods above
78-
4. Commit your changes
79-
80-
## Technology Stack
81-
82-
- **AngularJS** (1.8.2): JavaScript framework
83-
- **Angular Material**: UI component library
84-
- **ngRoute**: Routing module
85-
- **HTML5**: Markup
86-
- **CSS3**: Styling
87-
88-
## License
89-
90-
This project is licensed under the Apache-2.0 License.
91-
92-
## About Me
93-
94-
I'm Ongun Akay, a Senior Full-Stack Developer with expertise across various technologies.
95-
96-
- 👀 I specialize in full-stack development with extensive experience in frontend and backend technologies.
97-
- 🌱 Currently, I'm sharpening my skills in advanced concepts of web development.
98-
- 💞️ I’m always open to exciting collaborations and projects that challenge my abilities.
99-
100-
## Contributing
101-
102-
Feel free to submit issues and enhancement requests!
103-
104-
## Changelog
105-
106-
- Initial release with basic SPA functionality
107-
- Material Design integration
108-
- Responsive navigation menu
66+
---
67+
## 🔧 Development
68+
69+
Clone the repository
70+
Modify files as needed
71+
Run locally using one of the server methods above
72+
Push changes to `main` to trigger auto-deployment
73+
74+
---
75+
## 🛠️ Technology Stack
76+
- **AngularJS** (1.8.2)
77+
- **Angular Material**
78+
- **ngRoute**
79+
- **HTML5**, **CSS3**
80+
---
81+
## 📝 License
82+
This project is licensed under the **Apache-2.0 License**.
83+
---
84+
## 👨‍💻 About Me
85+
I'm **Ongun Akay**, a Senior Full-Stack Developer with expertise across various technologies.
86+
- 👀 I specialize in full-stack development with deep frontend/backend skills
87+
- 🌱 Currently sharpening advanced web architecture and deployment practices
88+
- 💬 Reach out: info@ongunakay.com
89+
---
90+
## 🤝 Contributing
91+
Pull requests, suggestions, and stars ⭐️ are always welcome!
92+
---
93+
## 📌 Changelog
94+
- ✅ Initial release with SPA functionality
95+
- 🎨 Angular Material styling added
96+
- 🚀 GitHub Pages deployment with CI/CD

0 commit comments

Comments
 (0)