README

nimara logo
Modern and high-performance e-commerce storefront for multi-region, global brands

Nimara Demo Join Discord View Documentation

Demo

Deploy with Vercel

https://github.com/user-attachments/assets/373825cf-a4fc-4123-86eb-639c4c40d96f

Features

  • Full commerce experience: Product catalog, search, cart, checkout, and customer accounts - everything a storefront needs to start selling, ready out of the box.

  • Multi-region & global brands: Sell across multiple channels, currencies, languages, and markets from a single storefront, with localized content and pricing.

  • Privacy-first analytics: Google Tag Manager and GA4 e-commerce tracking (product views, cart, checkout, purchase) built in, gated by Google Consent Mode v2 with a ready-made cookie consent banner. Enable it with a single env var, or plug in your own tracking provider.

  • Swap any integration: Commerce backend, CMS, search, and payments each sit behind a typed contract, so you can change providers without rewriting the app. Ships with Saleor as the default backend, plus ButterCMS and Algolia as drop-in alternatives.

  • Secure payments: Integrated Stripe checkout for reliable, PCI-compliant payment processing, ready to extend to other gateways.

  • Marketplace ready: Built-in support for vendor-aware, multi-seller marketplaces alongside standard single-brand stores.

  • AI & agent commerce: Universal Commerce Protocol (UCP) integration exposes your catalog and checkout to AI agents and external platforms.

  • Start in minutes, own everything: Zero-config storefront boots without any setup, and you own every line of code - no closed core, no required upgrades, no lock-in.

Built with developers’ favorite tools

The tech behind the features - a modern, fully typed stack we love working with:

Next.js React TypeScript Tailwind CSS shadcn/ui Radix UI Turborepo pnpm GraphQL Zod React Hook Form next-intl Vitest CodeceptJS Docusaurus ESLint Prettier Stripe

Prerequisites

This project uses pnpm and Turborepo, so make sure you have them installed globally in your system:

npm install -g pnpm
pnpm install turbo --global

⚡ Quickstart

Clone this repository, install pnpm and install all dependencies in the repo:

pnpm i

Start the storefront development server:

pnpm run dev:storefront

The app is now running at http://localhost:3000.

Zero-config: the storefront boots with no environment variables - every page renders with empty data (no products, no menu, checkout hidden). You only need a .env to connect a real backend.

To connect Saleor and other services, copy the storefront env template and fill in what you need:

cp apps/storefront/.env.example apps/storefront/.env

Every variable is optional and documented inline. Run pnpm preflight at any time to see which features are currently enabled and which env vars to set to turn the rest on.

To generate GraphQL types (requires NEXT_PUBLIC_SALEOR_API_URL in apps/storefront/.env), run:

pnpm run codegen

Daily Workflow and Releasing

Nimara uses trunk-based development: short-lived change branches merge into main, the only long-lived branch. The day-to-day and release process is documented here: Daily Workflow & Releasing - Nimara Docs.

Deploying the app to Vercel using a Terraform

A guide how to deploy the app to Vercel using Terraform can be found here: Using Terraform - Nimara Docs.

Documentation

The public documentation site is built with Docusaurus from apps/docs and published at docs.nimara.store.

Start with these docs:

For local development, build, deployment, and versioning of the docs site itself, see apps/docs/README.md.

Community & Contribution

Join Nimara community on Discord server. You can ask questions, report bugs, participate in discussions, share ideas or make feature requests.

You can also contribute to Nimara in various ways:

For detailed contributing guidelines, please see Contributing Guide

This wouldn’t have been possible without your support


Crafted with ❤️ by Mirumee Software

[email protected]

评论

暂无评论