Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/max1mde/portfolio
Customizable portfolio website built with Next.js
https://github.com/max1mde/portfolio
css javascript nextjs personal-website portfolio react shadcn-ui tailwind website
Last synced: 5 days ago
JSON representation
Customizable portfolio website built with Next.js
- Host: GitHub
- URL: https://github.com/max1mde/portfolio
- Owner: max1mde
- License: agpl-3.0
- Created: 2024-12-08T21:03:27.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-27T21:28:36.000Z (15 days ago)
- Last Synced: 2025-01-27T22:31:31.144Z (15 days ago)
- Topics: css, javascript, nextjs, personal-website, portfolio, react, shadcn-ui, tailwind, website
- Language: JavaScript
- Homepage: https://max1mde.vercel.app
- Size: 11.7 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 🚀 Quick Setup (5 Minutes)
1. [Fork the repository](https://github.com/max1mde/portfolio/fork)
2. Customize [CONFIG.json](CONFIG.json) in your fork with your personal information
3. Deploy to Vercel
Or deploy with one click
[](https://vercel.com/new/clone?repository-url=https://github.com/max1mde/portfolio)
## 📋 Table of Contents
- [Quick Setup](#-quick-setup-5-minutes)
- [Features](#-features)
- [Local Development](#-local-development)
- [Customization](#-customization)
- [Deployment](#-deployment)
- [Contributions](#-contributions)
- [Important Notes](#%EF%B8%8F-important-notes)
- [License](#-license)
- [Credits](#-credits)
## 💻 Local Development
1. [Fork the repository](https://github.com/max1mde/portfolio/fork)
2. Execute the following commands:
```bash
git clone https://github.com//portfolio.git
cd portfolio
npm install
npm run dev
```
## 🛠 Customization
Edit [CONFIG.json](CONFIG.json) to personalize:
- Site metadata
- Profile information
- Experience timeline
- Project cards
- Social links
- Contact form settings
- & More
### Fonts
Change global font in [CONFIG.json](CONFIG.json):
- `roboto`
- `delius`
- `audiowide`
## 🌐 Deployment
### Vercel (Recommended)
[](https://vercel.com/new/clone?repository-url=https://github.com/max1mde/portfolio)
### Other Platforms
- Ensure Node.js is installed
- Install all dependencies `npm install`
- Build with `npm run build`
- Start with `npm start`
## ⚠️ Important Notes
### Contact Form
**YOU MUST** implement your own contact form logic in [route.js](/src/app/api/contact/route.js). The current implementation is a placeholder.
### Personal Information
Remove or replace **(Please replace these before deployment)**:
- **Email addresses** like `[email protected]` (Very important)
- Social media links
- Profile image
- Experience details
- Projects
### Legal Disclaimer
This template is provided as-is, and you are responsible for:
- Implementing and securing contact form logic, ensuring compliance with GDPR and other privacy laws.
- Removing the original author’s personal information and ensuring no infringement on third-party intellectual property rights.
- Validating the functionality, ensuring security against unauthorized access or breaches, and updating for any legal changes.
- Providing users with the necessary privacy and cookie notices as required by law.
- Addressing any issues that may arise, including compatibility, security, and performance concerns.
By using or modifying this template, you agree to assume full responsibility for any legal or technical issues, including ensuring compliance with relevant legal requirements such as the "Impressum" (if applicable) and privacy laws in your jurisdiction.
## 📜 License
This project is licensed under the [GNU Affero General Public License v3.0](LICENSE)
## 🤝 Contributions
Contributions are welcome!
Here's how you can help:
- **Report Issues:** [Open an issue](https://github.com/max1mde/portfolio/issues/new?title=Please%20describe%20your%20issue%20or%20feature%20request&body=What%27s%20your%20problem%3F%0AOr%20do%20you%20maybe%20want%20a%20new%20feature%3F%0A%0ATell%20us%21) for bugs or feature requests.
- **Contribute Code:**
1. Fork the repository.
2. Create a branch: `git checkout -b feature/your-feature`.
3. Commit using the same message style (e.g., `feat: card hover effect`).
4. Push changes and submit a pull request.
- **Improve Docs:** Update the README or add missing info.
## 🏆 Credits
### Fonts
Font licenses available in [here](src/app/fonts/licenses/)
### Inspiration & Components
- [Custom Cursor](https://www.michieldb.nl/other/cursors/) by Michiel de Boer (Posy) [License](https://creativecommons.org/licenses/by-nc/4.0/deed.en)
- [Card Hover Effect](https://codepen.io/markmiro/pen/wbqMPa) by Mark Miro (MIT License)
- [Infinity Scrolling](https://codepen.io/kevinpowell/pen/BavVLra) by Kevin (MIT License)
---
**Developed with ❤️ by Maxim**