Skip to content

Commit 30a57cc

Browse files
committed
docs: update Readme
1 parent 621c9ff commit 30a57cc

File tree

1 file changed

+44
-26
lines changed

1 file changed

+44
-26
lines changed

README.md

Lines changed: 44 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,68 @@
11
## **Seif Soliman's Portfolio Website**
22

3-
🚀 **A personal portfolio showcasing my projects, skills, and achievements.**
3+
**A personal portfolio showcasing my projects, skills, and achievements.**
44

5-
![Portfolio Preview](img/projects/p2.png)
5+
![Portfolio Preview](public/img/projects/p2.png)
66

77
### **📌 Overview**
88

9-
This is my personal portfolio website, designed to highlight my work as a **Full Stack Developer**. It features a modern UI, responsive design, and smooth animations to create an engaging and interactive experience.
9+
This is my personal portfolio website, designed to highlight my work as a **Full Stack Developer**. It features a modern UI, responsive design, and smooth animations to create an engaging and interactive experience. Built with Vite for fast development and optimized production builds.
1010

1111
### **🔧 Technologies Used**
1212

13-
- **HTML5** - Structured and semantic markup
14-
- **CSS3** - Custom styles with responsive design
15-
- **JavaScript** - Interactive elements and animations
16-
- **FontAwesome** - Icons for better UI experience
17-
- **Git & GitHub** - Version control and project hosting
13+
- **HTML5** – Semantic, accessible markup
14+
- **CSS3** – Responsive, modern UI
15+
- **JavaScript (ES Modules)** – Interactive logic and animations
16+
- **Vite** – Dev server and build tooling
17+
- **PostCSS + Autoprefixer** – Cross-browser CSS
18+
- **ESLint + Prettier + Husky** – Code quality and formatting
19+
- **Font Awesome (CDN)** – Iconography
20+
- **@fontsource/poppins** – Typography
21+
- **Netlify Forms** – Contact form handling
22+
- **Git & GitHub** – Version control and hosting
1823

1924
### **📂 Project Structure**
2025

2126
```
22-
/portfolio-website
23-
│── /img # Images and assets
24-
│── styles.css # Stylesheet
25-
│── script.js # JavaScript file
26-
│── index.html # Main homepage
27-
│── README.md # Project documentation
27+
my-final-portfolio-website
28+
├── public/
29+
│ ├── data/ # JSON data (projects, certificates, tech stack)
30+
│ └── img/ # Images and assets
31+
├── index.html # Main page
32+
├── script.js # App logic (fetch + render)
33+
├── styles.css # Styles
34+
├── cv.html / cv.css / cv.js # CV page
35+
├── package.json # Scripts and tooling
36+
├── vite.config.js # Vite configuration
37+
└── README.md # Project documentation
2838
```
2939

3040
### **🎨 Features**
3141

32-
Fully responsive design
33-
Dynamic typing effect for introduction
34-
Interactive project showcase with modal view
35-
Certificates section
36-
Tech Stack section
37-
Contact form with email submission
38-
Social media links
42+
✔️ Fully responsive design
43+
✔️ Dynamic typing effect for introduction
44+
✔️ Interactive project showcase with modal view
45+
✔️ Certificates section
46+
✔️ Tech Stack section
47+
✔️ Contact form powered by Netlify Forms
48+
✔️ Social media links
3949

40-
### **🚀 Installation & Usage**
50+
### **🛠️ Installation & Usage**
4151

4252
1. Clone the repository:
4353
```sh
4454
git clone https://github.com/byseif21/portfolio-website.git
4555
```
46-
2. Open `index.html` in your browser.
47-
3. Customize the content as needed.
56+
2. Install dependencies and start the dev server:
57+
```sh
58+
npm install
59+
npm run dev
60+
```
61+
3. Build for production (optional) and preview locally:
62+
```sh
63+
npm run build
64+
npm run preview
65+
```
4866

4967
### **📜 License & Attribution**
5068

@@ -61,10 +79,10 @@ Your support means a lot, and I'd love to see how you customize it! 😊
6179

6280
- Design inspired by [EkiZR](https://github.com/EkiZR)
6381
- Icons by [FontAwesome](https://fontawesome.com)
64-
- Hosted on **GitHub Pages**
82+
- Deployed on **Netlify**
6583

6684
### **📩 Contact**
6785

68-
💻 Visit my portfolio: [seifsoliman.com](https://seifsoliman.netlify.app/)
86+
🌐 Visit my portfolio: [seifsoliman.com](https://seifsoliman.netlify.app/)
6987
📍 Contact me: [LinkedIn](https://www.linkedin.com/in/-seif-soliman/)
7088
👨‍💻 GitHub: [@byseif21](https://github.com/byseif21)

0 commit comments

Comments
 (0)