shadcn-portfolio

📋 Table of Contents

1. 🤖 Introduction
2. 🚀 Tech Stack
3. ✨ Features
4. 📚 Getting Started

🤖 Introduction

This is a Work In Progress portfolio template built using Next.JS, Framer Motion and Shadcn/UI. It's still a work-in-progress.

🚀 Tech Stack

• Next.js
• shadcn/ui
• Framer Motion
• Tailwind CSS

✨ Features

• ⚡️ Next.js 14 with App Router
• 📝 MDX
• 🎨 Tailwind CSS - for styling
• 🌈 Shadcn UI - accessible UI components
• 🛡 Strict TypeScript and ESLint configuration
• 📱 Responsive design
• 🌗 Light / Dark mode
• 📈 SEO optimized with meta tags
• 🗺 Sitemap (WIP)
• 📊 Sentry (setup required)
• 🎨 Animations - using Framer Motion
• 🏠 LightHouse score near 100
• 🔨 Husky & Lint Staged - lint and format code before committing
• ✅ Conventional commit lint - make sure commit messages follow the conventional commit format (WIP)
• 💄 Prettier - code formatting
• 👷🏻‍♂️ t3-env - validate environment variables before building (WIP)

📚 Getting Started

Follow these steps to set up the project locally on your machine.

Requirements

Make sure you have the following installed on your machine:

• Git
• Node.js (reccomended v20)
• npm (Node Package Manager, reccomended v9)

Setting up the Repository

npx create-next-app -e https://github.com/techwithanirudh/shadcn-portfolio
cd shadcn-portfolio

Running the Project

npm run dev

Open http://localhost:3000 in your browser to view the project.