Installation & Setup

Setup & Installation

Follow these steps to set up the Sitepins application for local development.

Prerequisites

Tool	Version	Purpose
Node.js	22.x or higher	Runtime environment
Yarn	1.22+	Recommended package manager
Git	Latest	Version control

Initial Setup

Clone the repository:


git clone https://github.com/sitepins/sitepins-app.git
cd sitepins-app

Install dependencies: Sitepins uses Yarn as its primary package manager.


yarn install

Environment Configuration

Copy the .env.example file to create your local .env and fill in the required credentials.


cp .env.example .env

🛠️ Core Configuration

NEXT_PUBLIC_BACKEND_URL: URL of the Sitepins Node.js backend.
PURCHASE_TOKEN_SECRET: Private secret for secure checkout tokens.
NEXT_PUBLIC_BUCKET_URL: DigitalOcean Spaces or S3 bucket endpoint.

🐙 Git Providers (Required for CMS)

GitHub App Credentials:

GITHUB_APP_ID
GITHUB_APP_CLIENT_ID
GITHUB_APP_CLIENT_SECRET
GITHUB_APP_PRIVATE_KEY (The full contents of your .pem file)
NEXT_PUBLIC_GITHUB_APP_NAME

GitLab OAuth Credentials:

NEXT_PUBLIC_GITLAB_APP_NAME
NEXT_PUBLIC_GITLAB_CLIENT_ID
GITLAB_CLIENT_SECRET

💳 Payment & Analytics

Paddle: PADDLE_API_KEY, NEXT_PUBLIC_PADDLE_CLIENT_TOKEN, PADDLE_NOTIFICATION_WEBHOOK_SECRET.
PostHog: NEXT_PUBLIC_POSTHOG_KEY.
Mixpanel: NEXT_PUBLIC_MIXPANEL_TOKEN.

🤖 AI Integration

OPENAI_API_KEY: Required for Sitepins AI content features.

Available Scripts

Command	Description
`yarn dev`	Runs the app in development mode with Next.js Turbopack.
`yarn build`	Builds the production-ready bundle.
`yarn start`	Starts the production server.
`yarn lint`	Runs ESLint for code quality checks.
`yarn format`	Automatically formats code using Prettier.

Development Versioning

Sitepins is currently built on Next.js 16.1.1 and React 19. Ensure your local development environment reflects these major versions to avoid compatibility issues.