Introduction

Openfront is a comprehensive e-commerce platform that provides everything you need to run an online store. It includes a complete admin dashboard, customer storefront, payment processing, and inventory management.

Automatic Installation

A minimum version of Node.js 20 required.

git clone https://github.com/openshiporg/openfront.git
cd openfront
npm install

Environment Setup

Create a .env file in the root directory:

# Required: Change this to a secure random string
SESSION_SECRET=your-super-secret-session-key-here

# Required: Your PostgreSQL database connection string
DATABASE_URL=postgresql://username:password@localhost:5432/openfront

# Optional: SMTP configuration for email notifications
SMTP_FROM="no-reply@yourdomain.com"
SMTP_HOST="your-smtp-host"
SMTP_PASSWORD="your-smtp-password"
SMTP_PORT="587"
SMTP_USER="your-smtp-user"

Start Development

Run the development server:

npm run dev

This will:

• Build the Keystone schema
• Run database migrations
• Start the development server

Open http://localhost:3000 with your browser to see the result.

Enjoy!

Your Openfront instance is now running! Start by setting up your store, adding products, and configuring your e-commerce settings.