Skip to content

Zyn-ic/portfolio-website

Repository files navigation

⚡ Open Source Portfolio Template

A high-performance, developer-centric portfolio template built with Next.js 15, Tailwind CSS, and Bun. Designed for speed, privacy, and ease of use.

✨ Key Features

  • 🚀 Performance First: Static site generation with optimized assets (MP4 backgrounds, compressed images).
  • 🎨 Shadcn/UI: Modern, accessible, and customizable UI components.
  • 🛠️ Zero-Code Config: Manage all content (Bio, Projects, Contact) via simple JSON files.
  • 🌍 Dynamic Timezone: Displays your local time to visitors without revealing your exact location (privacy-focused).
  • 📱 Responsive: Mobile-first design that looks great on any device.
  • ⏯️ Smart Background: Background video pauses automatically when tabs are inactive or modals are open to save system resources.

🚀 Quick Start

Prerequisites

  • Node.js (v18+)
  • Bun (Recommended package manager)

Installation

  1. Clone the repository

    git clone https://github.com/YOUR_USERNAME/portfolio-website.git
    cd portfolio-website
  2. Install dependencies

    bun install
  3. Run development server

    bun run dev

    Open http://localhost:3000 to view it.

📖 Documentation & Wiki

Detailed documentation is available in the Wiki (or the wiki-drafts folder in this repo):

  • Getting Started: Setup and Installation.
  • Configuration: How to edit about.json, projects.json, and set your Timezone.
  • Assets: Managing images and the background video.
  • Deployment: Deploying to Netlify, GitHub Pages, or Vercel.

🛠️ Built With

📄 License

This project is open source and available under the MIT License.

About

Personal portfolio website built with Next.js, featuring static export and optimized for GitHub Pages deployment

Topics

Resources

License

Stars

Watchers

Forks

Contributors