Steffen Illium
039816f863
All checks were successful
Next.js App CI / docker (push) Successful in 4m17s
79 lines
2.1 KiB
Markdown
79 lines
2.1 KiB
Markdown
# 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**.
|
|
|
|
<div align="center">
|
|
<img alt="Portfolio Overview" src="./overview.gif" width="90%">
|
|
</div>
|
|
|
|
---
|
|
|
|
## Key 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).
|
|
|
|
## Getting Started Locally
|
|
|
|
### Prerequisites
|
|
|
|
You need Node.js (v18+) and pnpm installed.
|
|
|
|
1. Clone this repository to your local machine (Update the URL below to your specific Gitea repository link):
|
|
|
|
```bash
|
|
git clone https://gitea.steffenillium.de/steffen/website.git
|
|
```
|
|
|
|
2. Move to the cloned directory:
|
|
|
|
```bash
|
|
cd website
|
|
```
|
|
|
|
3. Install dependencies:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
4. Start the local Server:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
5. Open the [Config file](./src/data/resume.tsx) and customize the content.
|
|
|
|
## 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)](https://dillion.io/):** Licensed under the [MIT license](https://github.com/dillionverma/portfolio/blob/main/LICENSE.md).
|
|
- **Current Repository (steffen/website):** Also [MIT License](https://gitea.steffenillium.de/steffen/website/src/branch/main/LICENSE).
|