Skip to main content
Get your Astro Portfolio v3 up and running in just 5 minutes. This guide will walk you through the essential steps to clone, install, and launch your development server.
1

Clone the repository

First, clone the repository to your local machine:
git clone https://github.com/yourusername/astro-portfolio.git
cd astro-portfolio
2

Install dependencies

Install all required dependencies using your preferred package manager. This project uses pnpm as the primary package manager:
pnpm install
The project is optimized for pnpm, but npm and yarn will also work. Dependencies include Astro v5.16+, Tailwind CSS v4.1+, and Cloudflare adapter.
3

Configure environment variables

Copy the example environment file and add your configuration:
cp .env.example .env
Update the .env file with your API keys:
.env
# Beehiiv Newsletter API Configuration
BEEHIIV_PUBLICATION_ID=your_publication_id_here
BEEHIIV_API_KEY=your_api_key_here
GTM_ID=your_google_tag_manager_id_here
The environment variables are optional for local development. The site will run without them, but newsletter subscription and analytics features won’t work.
4

Start the development server

Launch the local development server:
pnpm dev
Your portfolio will be available at http://localhost:4321 🎉The dev server features:
  • Hot module replacement (HMR)
  • Fast refresh on file changes
  • TypeScript type checking
  • Tailwind CSS live updates

​
What’s Next?

Installation Guide

Learn about detailed installation, prerequisites, and project structure

Customization

Customize your portfolio with your own content, styling, and components

Configuration

Configure site settings, environment variables, and integrations

Deployment

Deploy your portfolio to Cloudflare Pages or other platforms

​
Available Commands

Once installed, you have access to these commands:
CommandAction
pnpm devStarts local dev server at localhost:4321
pnpm buildBuild your production site to ./dist/
pnpm previewPreview your build locally, before deploying
pnpm astro ...Run CLI commands like astro add, astro check
pnpm astro -- --helpGet help using the Astro CLI
Run pnpm build before deploying to production to ensure all static assets are generated correctly.

Build docs developers (and LLMs) love

Get started for freeTalk to us