View Docs Download v2.4
Installation Progress 0%

Installation Guide

Step-by-step instructions to set up, configure, and deploy the Professional Portfolio template on your local machine or production environment.

📖 Overview

This guide walks you through installing the Professional Portfolio starter kit. The project is built with modern web standards, optimized for performance, accessibility, and rapid deployment.

ℹ️
This guide assumes basic familiarity with the command line, Git, and Node.js package managers.

⚙️ Prerequisites

Ensure your development environment meets the following requirements before proceeding:

  • Node.js v18.0 or higher Required
  • Package Manager: npm v9+, pnpm v8+, or yarn v1.22+
  • Git v2.30+ for version control
  • Modern Browser: Chrome 100+, Firefox 95+, Safari 15+, Edge 100+
  • At least 2GB free disk space
Terminal 
node -v && npm -v

🚀 Installation

Follow these steps to get the project running locally.

1

Clone the Repository

Download the latest stable release from our official repository.

Terminal 
git clone https://github.com/professional-portfolio/starter.git
cd starter
2

Install Dependencies

Use your preferred package manager to install all required modules.

Terminal 
# Using npm
npm install

# Or using pnpm (recommended)
pnpm install
3

Start Development Server

Launch the local development environment with hot-reloading enabled.

Terminal 
npm run dev

Your local server will be available at http://localhost:3000.

🛠️ Initial Setup

After installation, configure the core settings to match your project requirements.

  1. Open config/portfolio.json and update metadata
  2. Replace placeholder assets in /public/assets
  3. Configure routing in routes/index.js

🔑 Environment Variables

Create a .env.local file in the project root. Copy the template below and fill in your values.

.env.local 
PORT=3000
NODE_ENV=development
ANALYTICS_ID="your-ga-id-here"
MAILER_SERVICE="sendgrid"
API_KEY="sk-xxxxxxxxxxxxxxxx"
⚠️
Never commit your .env files to version control. They are already included in .gitignore.

📦 Build & Deploy

Generate an optimized production build before deploying to your hosting provider.

Terminal 
npm run build

The optimized output will be generated in the dist/ directory. You can now deploy this folder to:

  • Vercel (recommended for zero-config)
  • Netlify
  • GitHub Pages
  • Custom Nginx/Apache server

🔍 Troubleshooting

Common issues and their solutions.

This usually happens when npm was previously run with sudo. Fix your npm permissions by running: 
sudo chown -R $(whoami) /usr/local/lib/node_modules
npm cache clean --force
Change the port by updating PORT in your .env.local file, or kill the existing process: 
lsof -ti:3000 | xargs kill -9
Increase Node's memory allocation before building: 
NODE_OPTIONS="--max-old-space-size=4096" npm run build

💬 Need Help?

Our support team is available Monday through Friday, 9AM–5PM PST. Reach out via email or open a GitHub issue.

📧 Email Support 🐙 GitHub Issues 💬 Discord Community