Installation

Welcome to CozyCommerce — the modern, scalable, developer-first eCommerce solution built with Next.js. This guide will help you get up and running quickly, whether you're setting up a local development environment or preparing for production deployment.

✅ What You’ll Need

To set up CozyCommerce, make sure you have the following tools installed:

Node.js (version 19.0.0 or newer)
npm (version 10.0.0 or newer)
Git for version control

Using a version manager like nvm (opens in a new tab) is highly recommended for Node.js.

🔧 Configuration Overview

Before running CozyCommerce, you’ll need to configure your environment. Create a .env file in the root of the project and include all required credentials and API keys. These variables are essential for connecting to services like the database, email provider, image hosting, and more.

Key settings include:

API keys for Stripe, Cloudinary, Algolia
OAuth credentials (GitHub, Google)
SMTP settings (Resend)
Database connection string
NextAuth secrets
App URLs

⚠️ Always keep this file private and never upload it to a public repository.

🛠 Local Setup Instructions

Install all dependencies using:
```
npm install
```
Initialize Prisma for database interactions:
```
npx prisma generate
```
Start your local server:
```
npm run dev
```

You can now preview your site at http://localhost:3000.

🚀 Deploying to Production (Vercel)

CozyCommerce is fully compatible with Vercel (opens in a new tab), making it easy to go live:

Push your project to GitHub or another Git provider.
Sign in to Vercel and import your repository.
Configure all environment variables through the dashboard.
Select Next.js as your framework.
Click Deploy and let Vercel handle the rest.

Want to connect a custom domain? Vercel supports domain configuration out of the box.

🔗 Integrations & Services

CozyCommerce integrates with top-tier platforms to power your storefront:

Neon (opens in a new tab) — Cloud-native PostgreSQL database.
Cloudinary (opens in a new tab) — Media storage and optimization.
Stripe (opens in a new tab) — Payments and subscriptions.
Algolia (opens in a new tab) — Lightning-fast search solutions.
Resend (opens in a new tab) — Developer-first email API.
Formbold (opens in a new tab) — Backend for handling form submissions.
OAuth Providers: Set up GitHub (opens in a new tab) and Google (opens in a new tab) for social login support.

📖 Explore More

Visit our documentation for in-depth guides on every major feature:

👉 Read Full Documentation (opens in a new tab)

If you have questions or feedback, we’d love to hear from you. Visit our support page or join our discord community.

Introduction Database