Skip to main content
Get the portfolio website up and running on your local machine in just a few steps.
1

Clone the repository

Clone the portfolio repository from GitHub:
git clone https://github.com/avivkeller/avivkeller.github.io.git
cd avivkeller.github.io
2

Install dependencies

Install the required npm packages:
npm install
This project uses Node.js. Make sure you have Node.js 18 or higher installed. Check your version with node --version.
3

Start the development server

Run the development server to preview the site locally:
npm run dev
The site will be available at http://localhost:4321 (Astro’s default port).
The dev server includes hot module replacement, so your changes will appear instantly in the browser.
4

Customize your content

Start personalizing the portfolio by editing the data files:

Update site configuration

Edit src/data/index.ts to update your personal information:
src/data/index.ts
export const siteConfig = {
  name: "Your Name",
  title: "Your Name | Developer & Security Enthusiast",
  description: "Your custom description here.",
  author: {
    name: "Your Name",
    twitter: "@your_twitter",
    email: "you@example.com",
  },
};

Add your projects

Edit src/data/projects.ts to showcase your work:
src/data/projects.ts
export const projects: Project[] = [
  {
    title: "Your Project Name",
    description: "A brief description of your project",
    technologies: ["TypeScript", "Node.js"],
    githubLink: "https://github.com/yourusername/project",
    website: "https://your-project.com",
  },
  // Add more projects...
];
Modify src/data/index.ts to link to your profiles:
src/data/index.ts
export const socialLinks: SocialLink[] = [
  {
    href: "https://github.com/yourusername",
    icon: "simple-icons:github",
    label: "GitHub",
  },
  {
    href: "https://x.com/your_handle",
    icon: "simple-icons:x",
    label: "X (Twitter)",
  },
  // Add more social links...
];
5

Build for production

When you’re ready to deploy, build the production version:
npm run build
The static files will be generated in the dist/ directory.
Preview the production build locally with npm run preview before deploying.

Next steps

Now that your portfolio is running, explore these guides:

Customize Content

Learn how to add projects, achievements, and blog posts.

Styling

Customize colors, fonts, and the overall design.

Deploy to GitHub Pages

Deploy your portfolio to GitHub Pages for free.

Components

Explore the reusable Astro components available.
Don’t forget to replace the avatar image at src/assets/images/avatar.svg with your own photo!

Build docs developers (and LLMs) love