preview and readme update
All checks were successful
Next.js App CI / docker (push) Successful in 3m47s
All checks were successful
Next.js App CI / docker (push) Successful in 3m47s
This commit is contained in:
64
README.md
64
README.md
@@ -1,30 +1,37 @@
|
||||
# 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" src="https://github.com/dillionverma/portfolio/assets/16860528/57ffca81-3f0a-4425-b31d-094f61725455" width="90%">
|
||||
<img alt="Portfolio Overview" src="./overview.gif" width="90%">
|
||||
</div>
|
||||
|
||||
# Portfolio [](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.
|
||||
|
||||
1. Clone this repository to your local machine (Update the URL below to your specific Gitea repository link):
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dillionverma/portfolio
|
||||
git clone https://gitea.steffenillium.de/steffen/website.git
|
||||
```
|
||||
|
||||
2. Move to the cloned directory
|
||||
2. Move to the cloned directory:
|
||||
|
||||
```bash
|
||||
cd portfolio
|
||||
cd website
|
||||
```
|
||||
|
||||
3. Install dependencies:
|
||||
@@ -39,8 +46,33 @@ Built with next.js, [shadcn/ui](https://ui.shadcn.com/), and [magic ui](https://
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
5. Open the [Config file](./src/data/resume.tsx) and make changes
|
||||
5. Open the [Config file](./src/data/resume.tsx) and customize the content.
|
||||
|
||||
# License
|
||||
## Deployment (Docker)
|
||||
|
||||
Licensed under the [MIT license](https://github.com/dillionverma/portfolio/blob/main/LICENSE.md).
|
||||
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).
|
||||
|
||||
BIN
overview.gif
Normal file
BIN
overview.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 835 KiB |
Reference in New Issue
Block a user