diff --git a/README.md b/README.md index 4e65c769..915c2168 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,78 @@ +# Modern Portfolio Website + +A clean, high-performance portfolio template built with Next.js, [shadcn/ui](https://ui.shadcn.com/), and [magic ui](https://magicui.design/). This project is optimized for deployment using **Docker**. +
-Portfolio + Portfolio Overview
-# Portfolio [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdillionverma%2Fportfolio) +--- -Built with next.js, [shadcn/ui](https://ui.shadcn.com/), and [magic ui](https://magicui.design/), deployed on Vercel. +## Key Features -# Features +- Built using **Next.js 15, React, Typescript, Shadcn/UI, TailwindCSS, React/Motion, and Magic UI**. +- Intuitive **top navigation bar** for seamless user experience. +- Features **smooth animations** powered by `framer-motion` for a polished look. +- Fully responsive design for desktop, tablet, and mobile devices. +- Easily configure your entire portfolio by editing a [single config file](./src/data/resume.tsx). -- Setup only takes a few minutes by editing the [single config file](./src/data/resume.tsx) -- Built using Next.js 15, React, Typescript, Shadcn/UI, TailwindCSS, React/Motion, Magic UI -- Responsive for different devices -- Optimized for Next.js and Vercel +## Getting Started Locally -# Getting Started Locally +### Prerequisites -1. Clone this repository to your local machine: +You need Node.js (v18+) and pnpm installed. - ```bash - git clone https://github.com/dillionverma/portfolio - ``` +1. Clone this repository to your local machine (Update the URL below to your specific Gitea repository link): -2. Move to the cloned directory + ```bash + git clone https://gitea.steffenillium.de/steffen/website.git + ``` - ```bash - cd portfolio - ``` +2. Move to the cloned directory: -3. Install dependencies: + ```bash + cd website + ``` - ```bash - pnpm install - ``` +3. Install dependencies: -4. Start the local Server: + ```bash + pnpm install + ``` - ```bash - pnpm dev - ``` +4. Start the local Server: -5. Open the [Config file](./src/data/resume.tsx) and make changes + ```bash + pnpm dev + ``` -# License +5. Open the [Config file](./src/data/resume.tsx) and customize the content. -Licensed under the [MIT license](https://github.com/dillionverma/portfolio/blob/main/LICENSE.md). +## Deployment (Docker) + +This project is configured to be deployed easily using Docker. + +1. Build the Docker image: + + ```bash + docker build -t your-portfolio-name . + ``` + +2. Run the container, mapping port 3000: + + ```bash + docker run -d -p 3000:3000 your-portfolio-name + ``` + +The portfolio should now be accessible at `http://localhost:3000`. + +--- + +## Attribution and License + +This project is a fork and modification of the excellent work by **Dillion Verma**. Thank you for providing such a high-quality foundation! + +### Licensing + +- **Original Work (Dillion Verma):** Licensed under the [MIT license](https://github.com/dillionverma/portfolio/blob/main/LICENSE.md). +- **Current Repository (steffen/website):** Licensed under your [Specific License](https://gitea.steffenillium.de/steffen/website/src/branch/main/LICENSE). diff --git a/overview.gif b/overview.gif new file mode 100644 index 00000000..553d1f65 Binary files /dev/null and b/overview.gif differ