|
1 | | -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). |
| 1 | +# Sayfullah Eid - Developer Portfolio |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +A modern, responsive portfolio website built with Next.js 15, TypeScript, and Tailwind CSS. Features a clean design, blog functionality with MDX, and automatic deployment to GitHub Pages. |
4 | 4 |
|
5 | | -First, run the development server: |
| 5 | +## ✨ Features |
6 | 6 |
|
7 | | -```bash |
8 | | -npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | | -# or |
14 | | -bun dev |
| 7 | +- **🏠 Welcome Page** - Modern hero section with skills showcase and quick links |
| 8 | +- **💼 Experience Page** - Professional experience timeline with detailed achievements |
| 9 | +- **🚀 Projects Page** - Interactive project showcase with featured and regular projects |
| 10 | +- **📝 Blog** - MDX-powered blog with syntax highlighting and responsive design |
| 11 | +- **🌙 Dark/Light Theme** - Automatic theme switching with system preference support |
| 12 | +- **📱 Responsive Design** - Optimized for all device sizes |
| 13 | +- **⚡ Fast Performance** - Static site generation for optimal loading times |
| 14 | +- **🚀 Auto Deployment** - GitHub Actions workflow for automatic deployment to GitHub Pages |
| 15 | + |
| 16 | +## 🛠️ Tech Stack |
| 17 | + |
| 18 | +- **Framework**: Next.js 15 with App Router |
| 19 | +- **Language**: TypeScript |
| 20 | +- **Styling**: Tailwind CSS |
| 21 | +- **UI Components**: Shadcn/ui |
| 22 | +- **Blog**: MDX with gray-matter for frontmatter |
| 23 | +- **Icons**: Lucide React |
| 24 | +- **Deployment**: GitHub Pages |
| 25 | +- **Package Manager**: pnpm |
| 26 | + |
| 27 | +## 📁 Project Structure |
| 28 | + |
| 29 | +``` |
| 30 | +├── app/ # Next.js app directory |
| 31 | +│ ├── blog/ # Blog pages |
| 32 | +│ ├── experience/ # Experience page |
| 33 | +│ ├── projects/ # Projects page |
| 34 | +│ ├── layout.tsx # Root layout |
| 35 | +│ └── page.tsx # Home page |
| 36 | +├── components/ # Reusable components |
| 37 | +│ ├── ui/ # Shadcn/ui components |
| 38 | +│ ├── nav-menu.tsx # Navigation component |
| 39 | +│ └── mdx-components.tsx # MDX component mappings |
| 40 | +├── content/ # Content directory |
| 41 | +│ └── blog/ # Blog post MDX files |
| 42 | +├── lib/ # Utility functions |
| 43 | +│ ├── blog.ts # Blog utilities |
| 44 | +│ └── utils.ts # General utilities |
| 45 | +├── .github/workflows/ # GitHub Actions |
| 46 | +└── public/ # Static assets |
| 47 | +``` |
| 48 | + |
| 49 | +## 🚀 Getting Started |
| 50 | + |
| 51 | +### Prerequisites |
| 52 | + |
| 53 | +- Node.js 18+ |
| 54 | +- pnpm (recommended) or npm |
| 55 | + |
| 56 | +### Installation |
| 57 | + |
| 58 | +1. **Clone the repository** |
| 59 | + |
| 60 | + ```bash |
| 61 | + git clone https://github.com/FusionStreak/FusionStreak.github.io.git |
| 62 | + cd FusionStreak.github.io |
| 63 | + ``` |
| 64 | + |
| 65 | +2. **Install dependencies** |
| 66 | + |
| 67 | + ```bash |
| 68 | + pnpm install |
| 69 | + ``` |
| 70 | + |
| 71 | +3. **Run the development server** |
| 72 | + |
| 73 | + ```bash |
| 74 | + pnpm dev |
| 75 | + ``` |
| 76 | + |
| 77 | +4. **Open in browser** |
| 78 | + Navigate to [http://localhost:3000](http://localhost:3000) |
| 79 | + |
| 80 | +## 📝 Adding Content |
| 81 | + |
| 82 | +### Adding Blog Posts |
| 83 | + |
| 84 | +Create new MDX files in the `content/blog/` directory: |
| 85 | + |
| 86 | +```markdown |
| 87 | +--- |
| 88 | +title: "Your Post Title" |
| 89 | +date: "2024-01-15" |
| 90 | +excerpt: "A brief description of your post" |
| 91 | +author: "Your Name" |
| 92 | +tags: ["tag1", "tag2", "tag3"] |
| 93 | +featured: true |
| 94 | +readTime: "5 min read" |
| 95 | +--- |
| 96 | + |
| 97 | +# Your Post Title |
| 98 | + |
| 99 | +Your content here using Markdown/MDX syntax... |
| 100 | +``` |
| 101 | + |
| 102 | +### Adding Experience |
| 103 | + |
| 104 | +Edit the `experiences` array in `app/experience/page.tsx`: |
| 105 | + |
| 106 | +```typescript |
| 107 | +const experiences: Experience[] = [ |
| 108 | + { |
| 109 | + id: "new-id", |
| 110 | + title: "Your Job Title", |
| 111 | + company: "Company Name", |
| 112 | + location: "Location", |
| 113 | + startDate: "2024-01", |
| 114 | + endDate: undefined, // or "2024-12" for past roles |
| 115 | + description: "Job description...", |
| 116 | + achievements: ["Achievement 1", "Achievement 2"], |
| 117 | + technologies: ["React", "TypeScript", "Node.js"], |
| 118 | + website: "https://company.com" |
| 119 | + }, |
| 120 | + // ... existing experiences |
| 121 | +]; |
15 | 122 | ``` |
16 | 123 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 124 | +### Adding Projects |
| 125 | + |
| 126 | +Edit the `projects` array in `app/projects/page.tsx`: |
| 127 | + |
| 128 | +```typescript |
| 129 | +const projects: Project[] = [ |
| 130 | + { |
| 131 | + id: "new-project", |
| 132 | + title: "Project Name", |
| 133 | + description: "Short description", |
| 134 | + longDescription: "Detailed description...", |
| 135 | + technologies: ["Next.js", "TypeScript"], |
| 136 | + githubUrl: "https://github.com/username/repo", |
| 137 | + liveUrl: "https://project-demo.com", |
| 138 | + featured: true, |
| 139 | + createdAt: "2024-01-15", |
| 140 | + status: "completed" |
| 141 | + }, |
| 142 | + // ... existing projects |
| 143 | +]; |
| 144 | +``` |
| 145 | + |
| 146 | +## 🎨 Customization |
| 147 | + |
| 148 | +### Updating Personal Information |
18 | 149 |
|
19 | | -You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file. |
| 150 | +1. **Update metadata** in `app/layout.tsx` |
| 151 | +2. **Modify hero section** in `app/page.tsx` |
| 152 | +3. **Update social links** in `app/page.tsx` |
| 153 | +4. **Change skills** in `app/page.tsx` |
| 154 | + |
| 155 | +### Styling |
| 156 | + |
| 157 | +- **Colors**: Modify CSS variables in `app/globals.css` |
| 158 | +- **Components**: Customize Shadcn/ui components in `components/ui/` |
| 159 | +- **Layout**: Adjust the main layout in `app/layout.tsx` |
| 160 | + |
| 161 | +## 🚀 Deployment |
| 162 | + |
| 163 | +### Automatic Deployment (Recommended) |
| 164 | + |
| 165 | +The repository includes a GitHub Actions workflow that automatically deploys to GitHub Pages when you push to the main branch. |
| 166 | + |
| 167 | +1. **Enable GitHub Pages** in your repository settings |
| 168 | +2. **Set source** to "GitHub Actions" |
| 169 | +3. **Push to main branch** - deployment will trigger automatically |
| 170 | + |
| 171 | +### Manual Deployment |
| 172 | + |
| 173 | +```bash |
| 174 | +# Build the static site |
| 175 | +pnpm build |
| 176 | + |
| 177 | +# The output will be in the 'out' directory |
| 178 | +# Upload the contents to your hosting provider |
| 179 | +``` |
20 | 180 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. |
| 181 | +## 📦 Scripts |
22 | 182 |
|
23 | | -## Learn More |
| 183 | +- `pnpm dev` - Start development server |
| 184 | +- `pnpm build` - Build for production |
| 185 | +- `pnpm start` - Start production server |
| 186 | +- `pnpm lint` - Run ESLint |
24 | 187 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 188 | +## 🛡️ Licensing |
26 | 189 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 190 | +This repository uses a dual-license model: |
29 | 191 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! |
| 192 | +- **Code** (in `/app`, `/components`, etc.): Licensed under the [MIT License](./LICENSE) |
| 193 | +- **Content** (in `/content`, `/public`, etc.): Licensed under [CC BY-NC 4.0](./CONTENT_LICENSE) |
31 | 194 |
|
32 | | -## Deploy on Vercel |
| 195 | +If you want to reuse or republish parts of the content commercially, please contact me for permission. |
33 | 196 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 197 | +--- |
35 | 198 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |
| 199 | +Built with ❤️ by [Sayfullah Eid](https://github.com/FusionStreak) |
0 commit comments