README.md

April 24, 2025 · View on GitHub

Portfolio header

Important

Remember to change pre-defined values in config.tsx file (like name, description, socials etc.) before deploying your website! Change them in your forked repository.

📸 Screenshots

Home page

🖥️ Hosting

▲ Vercel

Deploy with Vercel

  1. Click on the button above or go to Vercel
  2. Fill GITHUB_ACCESS_TOKEN with your GitHub access token with public repositories permission
  3. Fill DISCORD_WEBHOOK_URL with your Discord Webhook URL for contact form
  4. Click on Deploy button and wait for deploy
  5. Click on Visit button to see your deployed website
  6. In your forked repository change pre-defined values in config.tsx file (like name, description, socials etc.)

🔩 Self Hosting

  1. Clone this repository git clone https://github.com/IgorKowalczyk/igorkowalczyk.dev.git
  2. Run pnpm i to install all dependencies,
  3. Run pnpm clean to remove all unnecessary files so you can start with a clean project
  4. Copy .env.example file and rename it to .env
  5. In .env file set this values:
    • GITHUB_ACCESS_TOKEN - Your GitHub access token with public repositories permission
    • DISCORD_WEBHOOK_URL - Discord Webhook URL for contact form
    • CAPTCHA_SECRET - Your Cloudflare Turnstile secret key (optional)
    • NEXT_PUBLIC_CAPTCHA_SITEKEY - Your Cloudflare Turnstile site key (optional)
  6. Edit pre-defined values in config.tsx file (like name, description, socials etc.)
  7. Run pnpm build to build the project or pnpm dev to run the project in development mode.

Note

You can also use npm or yarn instead of pnpm

📝 .env configuration

VariableDescriptionRequired
GITHUB_ACCESS_TOKENYour GitHub access token with public repositories permission☑️ Yes
DISCORD_WEBHOOK_URLDiscord Webhook URL for contact form☑️ Yes
HOTJAR_IDYour Hotjar website ID (for analytics)❌ No
CAPTCHA_SECRETYour Cloudflare Turnstile secret key❌ No
NEXT_PUBLIC_CAPTCHA_SITEKEYYour Cloudflare Turnstile site key❌ No

Note

You can set these optional values:

  • HOTJAR_ID - Your Hotjar website ID (for analytics)

⁉️ Issues

If you come across any errors or have suggestions for improvements, please create a new issue here and describe it clearly.

📥 Pull Requests

When submitting a pull request, please follow these steps:

  • Clone this repository https://github.com/IgorKowalczyk/igorkowalczyk.dev.git
  • Create a branch from main and give it a meaningful name (e.g. my-awesome-new-feature).
  • Open a pull request on GitHub and clearly describe the feature or fix you are proposing.

📋 License

This project is licensed under the MIT. See the LICENSE file for details