Installation
Install and run ShipNext locally.
Requirements
Install the following tools before starting:
- Node.js 22+
- pnpm 10+
Installation steps
Clone the repository
git clone https://github.com/shipnext/shipnext.git
cd shipnextInstall dependencies
pnpm installCopy environment variables
cp .env.example .env.localInitialize the database
ShipNext uses a local SQLite database by default:
pnpm db:push
# Open Drizzle Studio at https://local.drizzle.studio
pnpm db:studioStart the development server
# Default port 3000
pnpm dev
# Or choose a port
pnpm dev -p 3001Open the app
If you keep the defaults from .env.example, open http://localhost:3000. If you change the port, also update NEXT_PUBLIC_APP_URL and BETTER_AUTH_URL in .env.local.
Next steps
- Quick launch - Verify auth, database, Dashboard, and base pages.
- Project structure - Learn the main directory responsibilities.
- Database - Switch between SQLite and PostgreSQL.
- Website configuration - Configure brand, auth, payments, email, and legal pages.