|
1 | | -# Nuxt Starter Template |
| 1 | +# Iman Mohammadi — Design Engineer Portfolio |
2 | 2 |
|
3 | | -[](https://ui.nuxt.com) |
| 3 | + |
4 | 4 |
|
5 | | -Use this template to get started with [Nuxt UI](https://ui.nuxt.com) quickly. |
| 5 | +A high-performance, interactive portfolio website crafted with **Nuxt 4**, **Tailwind CSS 4**, and **Three.js**. This project showcases a clean grid-based layout, smooth GSAP animations, and an immersive 3D particle background. |
6 | 6 |
|
7 | | -- [Live demo](https://starter-template.nuxt.dev/) |
8 | | -- [Documentation](https://ui.nuxt.com/docs/getting-started/installation/nuxt) |
| 7 | +## ✨ Features |
9 | 8 |
|
10 | | -<a href="https://starter-template.nuxt.dev/" target="_blank"> |
11 | | - <picture> |
12 | | - <source media="(prefers-color-scheme: dark)" srcset="https://ui.nuxt.com/assets/templates/nuxt/starter-dark.png"> |
13 | | - <source media="(prefers-color-scheme: light)" srcset="https://ui.nuxt.com/assets/templates/nuxt/starter-light.png"> |
14 | | - <img alt="Nuxt Starter Template" src="https://ui.nuxt.com/assets/templates/nuxt/starter-light.png"> |
15 | | - </picture> |
16 | | -</a> |
| 9 | +- **3D Interactive Background**: Custom Three.js particle sphere with mouse parallax and scroll-based deformations. |
| 10 | +- **Modern Styling**: Built with the latest **Tailwind CSS v4** using the new CSS-first configuration (`@theme`). |
| 11 | +- **Animations**: Smooth transitions and micro-interactions powered by **GSAP**. |
| 12 | +- **UI Components**: polished components using **Nuxt UI v4**. |
| 13 | +- **Dark/Light Mode**: Fully responsive theme switching. |
| 14 | +- **Type Safe**: Written in **TypeScript** for robustness. |
17 | 15 |
|
18 | | -> The starter template for Vue is on https://github.com/nuxt-ui-templates/starter-vue. |
| 16 | +## 🛠 Tech Stack |
19 | 17 |
|
20 | | -## Quick Start |
| 18 | +- **Framework**: [Nuxt 4](https://nuxt.com) & [Vue 3](https://vuejs.org) |
| 19 | +- **Styling**: [Tailwind CSS 4](https://tailwindcss.com) & [Nuxt UI](https://ui.nuxt.com) |
| 20 | +- **3D & Animation**: [Three.js](https://threejs.org) & [GSAP](https://gsap.com) |
| 21 | +- **Icons**: [Nuxt Icon](https://nuxt.com/modules/icon) (Lucide, Simple Icons) |
| 22 | +- **Package Manager**: [pnpm](https://pnpm.io) |
21 | 23 |
|
22 | | -```bash [Terminal] |
23 | | -npm create nuxt@latest -- -t github:nuxt-ui-templates/starter |
24 | | -``` |
| 24 | +## 🚀 Getting Started |
25 | 25 |
|
26 | | -## Deploy your own |
| 26 | +This project uses **pnpm** as its package manager. |
27 | 27 |
|
28 | | -[](https://vercel.com/new/clone?repository-name=starter&repository-url=https%3A%2F%2Fgithub.com%2Fnuxt-ui-templates%2Fstarter&demo-image=https%3A%2F%2Fui.nuxt.com%2Fassets%2Ftemplates%2Fnuxt%2Fstarter-dark.png&demo-url=https%3A%2F%2Fstarter-template.nuxt.dev%2F&demo-title=Nuxt%20Starter%20Template&demo-description=A%20minimal%20template%20to%20get%20started%20with%20Nuxt%20UI.) |
| 28 | +### Prerequisites |
29 | 29 |
|
30 | | -## Setup |
| 30 | +- Node.js (v20 or v22+ recommended) |
| 31 | +- pnpm installed (`npm install -g pnpm`) |
31 | 32 |
|
32 | | -Make sure to install the dependencies: |
| 33 | +### Installation |
33 | 34 |
|
34 | | -```bash |
35 | | -pnpm install |
36 | | -``` |
37 | | - |
38 | | -## Development Server |
39 | | - |
40 | | -Start the development server on `http://localhost:3000`: |
41 | | - |
42 | | -```bash |
43 | | -pnpm dev |
44 | | -``` |
45 | | - |
46 | | -## Production |
47 | | - |
48 | | -Build the application for production: |
49 | | - |
50 | | -```bash |
51 | | -pnpm build |
52 | | -``` |
53 | | - |
54 | | -Locally preview production build: |
55 | | - |
56 | | -```bash |
57 | | -pnpm preview |
58 | | -``` |
59 | | - |
60 | | -Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. |
| 35 | +1. Clone the repository: |
| 36 | + ```bash |
| 37 | + git clone [https://github.com/iman-mohamadi/portfolio.git](https://github.com/iman-mohamadi/portfolio.git) |
| 38 | + cd portfolio |
0 commit comments