🚀 Quick Setup (5 Minutes)

1. Fork the repository
2. Customize CONFIG.json in your fork with your personal information
3. Deploy to Vercel

Or deploy with one click

📋 Table of Contents

• Quick Setup
• Features
• Local Development
• Customization
• Deployment
• Contributions
• Important Notes
• License
• Credits

💻 Local Development

1. Fork the repository
2. Execute the following commands:

git clone https://github.com/<your_username>/portfolio.git
cd portfolio
npm install
npm run dev

🛠 Customization

Edit CONFIG.json to personalize:

• Site metadata
• Profile information
• Experience timeline
• Project cards
• Social links
• Contact form settings
• & More

You can use placeholders in the config file which are defined in a .env file

NEXT_PUBLIC_PLACEHOLDERS={"%full_name%":"Your Name","%email%":"info[at]your.domain"}

Fonts

Change global font in CONFIG.json:

• roboto
• delius
• audiowide
• geist

🌐 Deployment

Vercel (Recommended)

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. The current implementation is a placeholder.

Personal Information

Remove or replace (Please replace these before deployment):

• My personal data
• Social media links
• Profile image
• Experience details
• Projects
• Generally everything that is not part of the base template and rather my personal info or assets

Warning:

Any attempt to impersonate me or misuse my personal information, including but not limited to my name, contact details, or any other data associated with me, is strictly prohibited. Such actions will lead to legal consequences, including but not limited to:

• Reporting to relevant authorities
• Civil claims for damages
• Criminal prosecution under applicable identity theft, data protection, and privacy laws within the European Union and beyond

Protecting my identity and personal information is a priority. Please respect this notice.

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

🤝 Contributions

Contributions are welcome!
Here's how you can help:

• Report Issues: Open an issue 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

Inspiration & Components

• Custom Cursor by Michiel de Boer (Posy) License
• Card Hover Effect by Mark Miro (MIT License)
• Infinity Scrolling by Kevin (MIT License)

People Using My Template

https://www.lvckyfelix.info/
https://kawaii-portfolio.vercel.app/
https://pratik-singh.vercel.app/

---

Developed with ❤️ by Maxim