Skip to content

ComplexMaJa/3DPortofolio

Repository files navigation

image

🎨 3D Portfolio

TypeScript React Vite License

✨ A stunning, high-performance 3D portfolio built with React, TypeScript, and Vite.


🚀 Quick Start

Prerequisites

  • pnpm (recommended) or npm
  • Node.js 18+

Installation & Development

# Install dependencies
pnpm install

# Start development server 
pnpm run dev

# Open http://localhost:5173 in your browser

Build for Production

cd react && pnpm build

✨ Features

  • 🎯 High Performance – Optimized bundle size, fast HMR with SWC
  • Modern Stack – React 19, TypeScript, Vite 7 with SWC plugin
  • 🎨 Tailwind CSS – Beautiful, utility-first styling
  • 🔍 Type-Safe – Strict TypeScript configuration
  • 📦 Optimized Assets – Efficient texture and media handling

📁 Project Structure

react/
├── src/
│   ├── main.tsx              # Entry point
│   ├── App.tsx               # Main app component
│   ├── index.css             # Global styles
│   ├── components/           # Reusable React components
│   └── assets/               # SVGs, images, and media
├── vite.config.ts            # Vite configuration
├── tsconfig.app.json         # TypeScript app config
└── package.json              # Project dependencies & scripts

🎯 Development Workflow

Adding a New Component

  1. Create your component in react/src/components/MyComponent.tsx:

    export default function MyComponent() {
      return <div>Hello World</div>;
    }
  2. Import and use it in react/src/App.tsx

  3. Run pnpm dev to see changes with HMR

Using Tailwind CSS

Tailwind is already configured. Just use utility classes in your JSX:

<div className="flex items-center justify-center min-h-screen bg-gradient-to-br from-slate-900 to-slate-800">
  {/* Your content */}
</div>

⚙️ Tech Stack

  • Frontend: React 19 + TypeScript
  • Build Tool: Vite 7 + SWC (Fast Refresh)
  • Styling: Tailwind CSS + PostCSS
  • Linting: ESLint with TypeScript support
  • Package Manager: pnpm (with lock file)

🎮 Performance Tips

Before submitting changes:

  • Run pnpm build to keep bundles lean
  • Run pnpm lint to ensure code quality
  • Test on mobile or throttled networks via DevTools
  • Verify smooth 3D rendering on slower hardware

📝 Key Configuration Files

File Purpose
vite.config.ts Vite build configuration with SWC plugin
tsconfig.app.json Strict TypeScript settings
tailwind.config.js Tailwind CSS theme & utilities
eslint.config.js Linting rules

🤝 Contributing

I welcome contributions! Here's how to get started:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

🌟 Show Your Support

Currently very W.I.P so expect alot more in the future!, consider ⭐'ing the repo if you found it useful :D

image

About

calm lil portofolio

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published