Installation & Setup

This guide walks you through deploying Retrail on your machine or server.

Requirements

Download the Retrail release package (retrail.zip) and extract it to your desired folder:

unzip retrail.zip -d retrail
cd retrail

Install project dependencies:

npm install

Edit settings.json in the root directory to customize your portfolio:

nano settings.json

See the Configuration Guide for the full setting reference.

Start Next.js in development mode:

npm run dev

Open http://localhost:3000 in your browser to view your portfolio.

Compile an optimized production bundle:

npm run build

Launch the production server:

npm run start

npm run start serves Retrail on port 3000 by default. You can change the port with -p, for example: npx next start -p 8080.

To run Retrail persistently in the background:

npm install -g pm2
pm2 start npm --name "retrail" -- run start
pm2 save