/portfolio-website

Personal website created with Next.js, TypeScript and Tailwind CSS

Primary LanguageTypeScript

Portfolio Website 🌟

Welcome to the repository for my portfolio website! This website serves as a showcase of my skills, projects, and experiences. Below you'll find everything you need to know to get started with the project.

Table of Contents 📋

Installation 💻

To get started with the project, follow these steps:

  1. Clone the repository: git clone https://github.com/your-username/portfolio-website.git
  2. Navigate into the project directory: cd portfolio-website
  3. Install dependencies: npm install

Usage 🚀

Once you have installed the dependencies, you can run the following npm scripts:

  • npm run dev: Starts the development server.
  • npm run build: Builds the production-ready files.
  • npm start: Starts the production server.
  • npm run lint: Lints the project files.

Dependencies 🛠️

Here are the main dependencies used in this project:

  • @vercel/analytics: For website analytics provided by Vercel.
  • @vercel/speed-insights: For speed insights provided by Vercel.
  • form-data, formidable: Handling form data.
  • framer-motion: Animation library for React components.
  • hamburger-react: React component for hamburger menu.
  • mailgun.js: Integration with Mailgun for contact form submission.
  • next: React framework for server-rendered applications.
  • react, react-dom: Core React libraries.
  • react-type-animation: Library for typewriter-like animations.
  • remixicon: Icon library for modern web projects.

Contact Form 📧

The contact form in this project utilizes the Mailgun integration to ensure that messages submitted through the form are received as emails. The API route for handling contact form submissions can be found in pages/api/contact.ts.

Hosting and Analytics 🌐

This project is designed to be deployed on the Vercel platform, which provides hosting, analytics, and speed insights out of the box. With Vercel, you can easily manage your domain and monitor the performance of your website.

License 📄

This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License (CC BY-NC-ND).

Under this license, you are free to:

  • Share — copy and redistribute the material in any medium or format.

Under the following terms:

  • Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

  • NonCommercial — You may not use the material for commercial purposes.

  • NoDerivatives — If you remix, transform, or build upon the material, you may not distribute the modified material.