limlabs / developer-portfolio

1 stars 1 forks source link

Payload Portfolio Starter

Demo 👀

Quick Start

Deploy with Vercel

Follow the instructions after the first deployment to complete setup.

What's Included

For Content Authors

For Developers

For UI / UX Designers

Things you need to bring

Basic Deployment

For Local Development + Customization

Dependencies

Setup

Step 1: Install dependencies

Make sure you have Node.js, npm or yarn installed on your system. Navigate to the project directory and install all required packages using one of the following commands:

pnpm i

Step 2: Set up environment variables

Copy the .env.example file to .env.local under the root directory and add your PostgreSQL database connection details as environment variables. The .env.local file will be ignored by Git.

# db
POSTGRES_URL=postgresql://user:pass@localhost

# payload
PAYLOAD_SECRET=PAYLOAD_CUSTOM_SERVER_EXAMPLE_SECRET_KEY
PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
PAYLOAD_PUBLIC_DRAFT_SECRET=EXAMPLE_DRAFT_SECRET
COOKIE_DOMAIN=localhost
REVALIDATION_KEY=EXAMPLE_REVALIDATION_KEY
PAYLOAD_SEED=false
PAYLOAD_DROP_DATABASE=false
ENABLE_PAYLOAD_CLOUD=false

# vercel
VERCEL_BUTTON_REPO="https://github.com/limlabs/developer-portfolio/tree/feat-vercel-deploy"
VERCEL_BUTTON_PROJECT="payload-developer-portfolio"
VERCEL_BUTTON_SHOW=false

Step 3: Seed the database

Seed the demo data by running:

pnpm seed

Step 4: Run the project

Start the development server by running:

pnpm dev

The Next.js development server will start, and you should be able to access your project at http://localhost:3000.