Skip to content

Commit 37e6641

Browse files
committed
updated the readme file
1 parent 405f30c commit 37e6641

File tree

1 file changed

+206
-143
lines changed

1 file changed

+206
-143
lines changed

README.md

Lines changed: 206 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,210 @@
1-
# Suraj Kumar - Personal Portfolio
2-
3-
This is the source code for my personal portfolio website, designed to showcase my skills, projects, journey, and ways to connect with me. It's built with HTML, CSS, and JavaScript, featuring a responsive design and interactive elements.
4-
5-
<!-- Optional: Add a screenshot or GIF of your portfolio here -->
6-
<!-- ![Portfolio Screenshot](link_to_your_screenshot.png) -->
7-
8-
**Live Demo:** [Suraj.in](https://surajsk2003.github.io/Suraj.in/)
9-
10-
## Features
11-
12-
* **Responsive Design:** Adapts to various screen sizes (desktop, tablet, mobile).
13-
* **Interactive Sidebar Navigation:**
14-
* Toggleable on mobile.
15-
* Peeks out on desktop and expands on hover or click.
16-
* Closes on link click (mobile).
17-
* Active link highlighting based on scroll position and current page.
18-
* **Particle.js Background:** Dynamic animated background.
19-
* **Typed Text Animation:** Engaging "I am..." text animation on the home section.
20-
* **Social Links Carousel:** Horizontally scrolling carousel of social/professional links (Resume, LinkedIn, Kaggle, Twitter, GitHub).
21-
* **Detailed "About Me" Section:**
22-
* Introduction and professional summary.
23-
* "Phases of My Life" section with interactive flip cards.
24-
* **Skills Section:** Categorized skills displayed in an accordion interface.
25-
* **Separate Pages:** Dedicated pages for:
26-
* Game Zone (`games.html`)
27-
* Projects (`projects.html`)
28-
* Certifications (`certifications.html`)
29-
* Contact (`contact.html`)
30-
* **Custom Fonts:** Utilizes a selection of Google Fonts for a unique and stylish appearance.
31-
* **Project Modal:** (On `projects.html`) Displays detailed information about each project when a card is clicked.
32-
* **Contact Form:** (On `contact.html`) Allows visitors to send messages directly (requires a backend service like Formspree or a custom backend).
33-
* **Styled Footer:**
34-
* Inspirational quotes section.
35-
* General and Important Links sections (accordion on mobile).
36-
* Copyright information.
37-
38-
## Technologies Used
39-
40-
* **Frontend:**
41-
* HTML5
42-
* CSS3 (Flexbox, Grid, Animations, Transitions, Responsive Media Queries)
43-
* JavaScript (ES6+)
44-
* DOM Manipulation
45-
* Event Listeners
46-
* `fetch` API (for contact form)
47-
* Custom animations and interactive components (accordions, modal, sidebar, typing animation)
48-
* **Libraries/Frameworks:**
49-
* Particle.js - For the animated background.
50-
* **Tools:**
51-
* VS Code (or any preferred code editor)
52-
* Git & GitHub (for version control)
53-
* **Fonts (from Google Fonts):**
54-
* Poppins (Primary body font)
55-
* Emilys Candy
56-
* Moon Dance
57-
* Playfair Display
58-
* Dancing Script
59-
* Pacifico
60-
* VS Code (or any preferred code editor)
61-
* Git & GitHub (for version control)
62-
63-
## File Structure
1+
<div align="center">
2+
<h1>🚀 Suraj Kumar - Personal Portfolio</h1>
3+
4+
<p>
5+
<strong>A modern, responsive portfolio showcasing my journey as an AI/ML enthusiast and aspiring software engineer</strong>
6+
</p>
7+
8+
<p>
9+
<a href="https://surajsk2003.github.io/Suraj.in/">🌐 Live Demo</a> •
10+
<a href="#features">✨ Features</a> •
11+
<a href="#tech-stack">🛠️ Tech Stack</a> •
12+
<a href="#quick-start">🚀 Quick Start</a>
13+
</p>
14+
15+
<img src="https://img.shields.io/badge/status-live-brightgreen" alt="Status">
16+
<img src="https://img.shields.io/badge/responsive-yes-blue" alt="Responsive">
17+
<img src="https://img.shields.io/badge/vanilla-js-yellow" alt="Vanilla JS">
18+
<img src="https://img.shields.io/github/last-commit/surajsk2003/Suraj.in" alt="Last Commit">
19+
</div>
20+
21+
---
22+
23+
## 🌟 About
24+
25+
Welcome to my digital space! This portfolio represents my journey as a **B.Tech Electrical Engineering student at NITK Surathkal** passionate about **AI/ML, software development, and creating impactful solutions**. Built from scratch with vanilla technologies, it showcases my projects, skills, and the various phases of my life.
26+
27+
**🎯 Current Focus:** Preparing for placements, developing AI/ML projects, and building a strong foundation for my entrepreneurial journey.
28+
29+
## ✨ Features
30+
31+
### 🎨 **Design & User Experience**
32+
- **Fully Responsive** - Seamless experience across all devices
33+
- **Interactive Particle.js Background** - Dynamic animated canvas
34+
- **Smooth Animations** - CSS transitions and custom JavaScript animations
35+
- **Typography Excellence** - Carefully selected Google Fonts combination
36+
37+
### 🧭 **Navigation & Interactivity**
38+
- **Smart Sidebar Navigation** - Hover/click expandable with active link highlighting
39+
- **Typed Text Animation** - Engaging "I am..." rotating text effect
40+
- **Social Links Carousel** - Horizontal scrolling professional links
41+
- **Mobile-First Design** - Optimized for touch interactions
42+
43+
### 📱 **Multi-Page Architecture**
44+
- **Home** (`index.html`) - Introduction, About Me, Skills
45+
- **Projects** (`projects.html`) - Portfolio projects with modal details
46+
- **Certifications** (`certifications.html`) - Academic and professional achievements
47+
- **Contact** (`contact.html`) - Direct messaging form
48+
- **Game Zone** (`games.html`) - Interactive entertainment section
49+
50+
### 🎯 **Interactive Components**
51+
- **Flip Cards** - "Phases of My Life" section with hover effects
52+
- **Skills Accordion** - Categorized technical skills display
53+
- **Project Modals** - Detailed project information overlays
54+
- **Contact Form Integration** - Direct messaging capability
55+
56+
## 🛠️ Tech Stack
57+
58+
<table>
59+
<tr>
60+
<td><strong>Frontend</strong></td>
61+
<td>
62+
<img src="https://img.shields.io/badge/HTML5-E34F26?style=flat&logo=html5&logoColor=white" alt="HTML5">
63+
<img src="https://img.shields.io/badge/CSS3-1572B6?style=flat&logo=css3&logoColor=white" alt="CSS3">
64+
<img src="https://img.shields.io/badge/JavaScript-F7DF1E?style=flat&logo=javascript&logoColor=black" alt="JavaScript">
65+
</td>
66+
</tr>
67+
<tr>
68+
<td><strong>Libraries</strong></td>
69+
<td>
70+
<img src="https://img.shields.io/badge/Particles.js-000000?style=flat&logo=javascript&logoColor=white" alt="Particles.js">
71+
</td>
72+
</tr>
73+
<tr>
74+
<td><strong>Tools</strong></td>
75+
<td>
76+
<img src="https://img.shields.io/badge/VS_Code-007ACC?style=flat&logo=visual-studio-code&logoColor=white" alt="VS Code">
77+
<img src="https://img.shields.io/badge/Git-F05032?style=flat&logo=git&logoColor=white" alt="Git">
78+
<img src="https://img.shields.io/badge/GitHub_Pages-222222?style=flat&logo=github&logoColor=white" alt="GitHub Pages">
79+
</td>
80+
</tr>
81+
<tr>
82+
<td><strong>Typography</strong></td>
83+
<td>Poppins • Emilys Candy • Moon Dance • Playfair Display • Dancing Script • Pacifico</td>
84+
</tr>
85+
</table>
86+
87+
### 🔧 **Technical Implementation**
88+
- **CSS Grid & Flexbox** for responsive layouts
89+
- **ES6+ JavaScript** with modern DOM manipulation
90+
- **Fetch API** for form submissions
91+
- **CSS Custom Properties** for consistent theming
92+
- **Mobile-first responsive design** with breakpoints
93+
94+
## 📁 Project Structure
6495

6596
```
66-
static-portfolio/
67-
├── index.html # Main landing page (Home, About, Skills)
68-
├── projects.html # Projects page
69-
├── certifications.html # Certifications page
70-
├── contact.html # Contact page
71-
├── styles.css # Main stylesheet
72-
├── scripts.js # Main JavaScript file
73-
├── particles.js # Particle.js library file
74-
├── particle-config.js # Custom configuration for Particle.js
75-
├── images/ # Folder for all images
76-
│ ├── profile_picture.jpeg
77-
│ ├── github.png
78-
│ ├── linkedin.png
79-
│ ├── resume-icon.png
80-
│ ├── kaggle-icon.png
81-
│ ├── twitter-icon.png
82-
│ └── ... (other project/certification images)
83-
└── README.md # This file
97+
Suraj.in/
98+
├── 📄 index.html # Main landing page (Home, About, Skills)
99+
├── 📄 projects.html # Projects showcase page
100+
├── 📄 certifications.html # Certifications and achievements
101+
├── 📄 contact.html # Contact form page
102+
├── 🎨 styles.css # Main stylesheet
103+
├── ⚡ scripts.js # Interactive functionality
104+
├── 🌟 particles.js # Particle.js library
105+
├── ⚙️ particle-config.js # Particle animation configuration
106+
├── 📁 images/ # All visual assets
107+
│ ├── 👤 profile_picture.jpeg
108+
│ ├── 🔗 social media icons
109+
│ └── 🖼️ project screenshots
110+
└── 📚 README.md # Project documentation
84111
```
85112

86-
## Setup
87-
88-
1. **Clone the repository (if applicable):**
89-
```bash
90-
git clone https://github.com/your-username/your-repo-name.git
91-
cd your-repo-name
92-
```
93-
2. **Open `index.html`:** Navigate to the project directory and open `index.html` in your preferred web browser.
94-
95-
No special build steps are required as this is a static website.
96-
97-
## Customization
98-
99-
To personalize this portfolio for your own use:
100-
101-
1. **Personal Information:**
102-
* Update name, bio, and "Phases of My Life" content in `index.html`.
103-
* Replace `images/profile_picture.jpeg` with your photo.
104-
2. **Skills:**
105-
* Modify the skills categories and individual skills in the "Skills" section of `index.html`.
106-
3. **Projects:**
107-
* Edit `projects.html` to add, remove, or modify project cards.
108-
* Ensure `data-*` attributes on project cards in `projects.html` are updated for the modal functionality in `scripts.js`.
109-
* Add corresponding project images to the `images/` folder.
110-
4. **Certifications:**
111-
* Edit `certifications.html` to list your certifications.
112-
* Add any relevant certificate images or links.
113-
5. **Contact Form:**
114-
* In `contact.html`, update the `action` attribute of the `<form>` tag to point to your backend service endpoint (e.g., your Formspree URL).
115-
6. **Links:**
116-
* Update social media links in the sidebar and the social links carousel in `index.html`.
117-
* Update the resume link in `index.html`.
118-
* Update links in the footer sections of `index.html`.
119-
7. **Images:**
120-
* Replace placeholder images in the `images/` folder with your actual images (e.g., `resume-icon.png`, `kaggle-icon.png`, `twitter-icon.png`).
121-
8. **Quotes:**
122-
* Modify the quotes in the footer section of `index.html`.
123-
9. **Styling:**
124-
* Adjust colors, fonts, and layout in `styles.css` as needed.
125-
10. **Typed Text:**
126-
* Update the `textArray` in `scripts.js` for the home page typing animation.
127-
128-
## Future Enhancements (Ideas)
129-
130-
* Implement the "Blogs (Coming Soon)" section.
131-
* Integrate the commented-out "live animation" or "floating ball" features.
132-
* Add more advanced animations or micro-interactions.
133-
* Optimize images for faster loading.
134-
135-
## Acknowledgements
136-
137-
* Particle.js by Vincent Garreau for the background animation.
138-
139-
## Contact
140-
141-
If you have any questions or want to connect, feel free to reach out!
142-
* **LinkedIn:** [suraj-singh-96b45220a](https://www.linkedin.com/in/suraj-singh-96b45220a/)
143-
* **GitHub:** [surajsk2003](https://github.com/surajsk2003)
144-
* **Email:** surajkumarsksk2000@gmail.com
145-
* **Blog:** [my-blog-lemon-mu-45.vercel.app/](https://my-blog-lemon-mu-45.vercel.app/)
146-
147-
---
113+
## 🚀 Quick Start
114+
115+
### Prerequisites
116+
- A modern web browser (Chrome, Firefox, Safari, Edge)
117+
- Basic understanding of HTML/CSS/JS (for customization)
118+
119+
### Installation
120+
121+
```bash
122+
# Clone the repository
123+
git clone https://github.com/surajsk2003/Suraj.in.git
124+
125+
# Navigate to project directory
126+
cd Suraj.in
127+
128+
# Open in browser (or use live server)
129+
open index.html
130+
```
131+
132+
### 🔥 Development Setup
133+
134+
```bash
135+
# For live reload during development
136+
npx live-server
137+
138+
# Or use VS Code Live Server extension
139+
# Right-click on index.html → "Open with Live Server"
140+
```
141+
142+
## 🎨 Customization Guide
143+
144+
<details>
145+
<summary><strong>🔧 Click to expand customization instructions</strong></summary>
146+
147+
### Personal Information
148+
1. **Profile**: Replace `images/profile_picture.jpeg` with your photo
149+
2. **Content**: Update bio and "Phases of My Life" in `index.html`
150+
3. **Skills**: Modify skill categories and items in the Skills section
151+
152+
### Projects & Certifications
153+
1. **Projects**: Edit `projects.html` and update `data-*` attributes for modals
154+
2. **Images**: Add project screenshots to `images/` folder
155+
3. **Certifications**: Update `certifications.html` with your achievements
156+
157+
### Contact & Links
158+
1. **Form**: Update form `action` attribute in `contact.html` (Formspree recommended)
159+
2. **Social Links**: Modify links in sidebar and carousel sections
160+
3. **Resume**: Update resume link in navigation
161+
162+
### Styling & Branding
163+
1. **Colors**: Adjust CSS custom properties in `styles.css`
164+
2. **Typography**: Modify font imports and font-family declarations
165+
3. **Animations**: Customize typing animation array in `scripts.js`
166+
167+
</details>
168+
169+
## 🌐 Live Demo
170+
171+
**Visit:** [surajsk2003.github.io/Suraj.in](https://surajsk2003.github.io/Suraj.in/)
172+
173+
Experience the full portfolio with all interactive features, animations, and responsive design elements.
174+
175+
## 📈 Performance Features
176+
177+
-**Fast Loading** - Optimized images and minimal dependencies
178+
- 📱 **Mobile Optimized** - Touch-friendly interactions
179+
- 🎯 **SEO Ready** - Semantic HTML structure
180+
-**Accessible** - Keyboard navigation support
181+
182+
## 🤝 Contributing
183+
184+
While this is a personal portfolio, I welcome feedback and suggestions! Feel free to:
185+
186+
1. 🐛 [Open an issue](https://github.com/surajsk2003/Suraj.in/issues) for bugs
187+
2. 💡 [Suggest features](https://github.com/surajsk2003/Suraj.in/issues) for improvements
188+
3. 🔧 Submit pull requests for enhancements
189+
190+
## 📝 License
191+
192+
This project is open source and available under the [MIT License](LICENSE).
193+
194+
## 📬 Connect With Me
195+
196+
<div align="center">
197+
198+
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/suraj-singh-96b45220a/)
199+
[![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/surajsk2003)
200+
[![Email](https://img.shields.io/badge/Email-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:surajkumarsksk2000@gmail.com)
201+
[![Blog](https://img.shields.io/badge/Blog-000000?style=for-the-badge&logo=vercel&logoColor=white)](https://my-blog-lemon-mu-45.vercel.app/)
202+
203+
</div>
204+
205+
---
206+
207+
<div align="center">
208+
<p><strong>⭐ If you found this portfolio inspiring, consider giving it a star!</strong></p>
209+
<p><em>Built with ❤️ by Suraj Kumar | NITK Surathkal | Class of 2025</em></p>
210+
</div>

0 commit comments

Comments
 (0)