Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muhreeowki/portfolio
This is the code for my personal protfolio website, built with NextJS. It is fully customizeable.
https://github.com/muhreeowki/portfolio
nextjs portfolio
Last synced: 2 months ago
JSON representation
This is the code for my personal protfolio website, built with NextJS. It is fully customizeable.
- Host: GitHub
- URL: https://github.com/muhreeowki/portfolio
- Owner: muhreeowki
- Created: 2024-08-06T14:34:32.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T07:14:46.000Z (4 months ago)
- Last Synced: 2024-09-16T08:45:26.342Z (4 months ago)
- Topics: nextjs, portfolio
- Language: TypeScript
- Homepage: https://www.muriuki.tech
- Size: 50.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
shadcn-portfolio
## 📋 Table of Contents
1. 🤖 [Introduction](#introduction)
2. 🚀 [Tech Stack](#tech-stack)
3. ✨ [Features](#features)
4. 📚 [Getting Started](#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
- 🔨 Husky & Lint Staged - lint and format code before committing
- 💄 Prettier - code formatting
Follow these steps to set up the project locally on your machine.
**Requirements**
Make sure you have the following installed on your machine:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en) (reccomended v20)
- [npm](https://www.npmjs.com/) (Node Package Manager, reccomended v9)
**Setting up the Repository**
```bash
npx create-next-app -e https://github.com/techwithanirudh/shadcn-portfolio
cd shadcn-portfolio
```
**Running the Project**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.
#