Skip to content

Latest commit

 

History

History
114 lines (71 loc) · 4.98 KB

README.md

File metadata and controls

114 lines (71 loc) · 4.98 KB
Raw
nimara logo
Modern and high-performance e-commerce storefront for multi-region, global brands

Nimara Demo Join Discord View Documentation

🎥 Demo

Deploy with Vercel

Nimara.Storefront.mov

🚀 Features

  • Headless Architecture: Nimara's headless architecture provides a flexible, easy-to-maintain, and ready-to-deploy solution for online businesses.

  • Next.js 14: App router, React Server Components (RSC), Server Actions, Caching and Static Site Generation (SSG) support with Typescript setup.

  • Shadcn UI/Tailwind CSS: Nimara's UI uses Shadcn UI and Tailwind CSS, providing a modern and customizable design system.

  • Turborepo: Nimara's monorepo is powered by Turborepo, a fast and scalable build system for monorepos. Automated tests with Playwright and setup for Docs are included.

  • Stripe Integration: Nimara's storefront uses Stripe Payment Element for secure payment processing.

  • Customizable infrastructure: Nimara's infrastructure is highly customizable, allowing you to tailor it to your specific needs and requirements. Extend it by providing the setup to any third-party service.

  • Tooling included: Comes with ESLint, Prettier, Husky, Lint Staged, and Codegen preconfigured.

🔧 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 and copy .env.example to .env:

cp .env.example .env

Edit .env file and provide required variables.

Then, install pnpm and run the following command to install all dependencies in the repo:

pnpm i

To start just the development server for storefront, run this

pnpm run dev:storefront

To generate a new types, run this:

pnpm run codegen

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

❤️ Community & Contribution

Join Nimara community on GitHub Discussions and 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:

This wouldn't have been possible without your support


Crafted with ❤️ by Mirumee Software

[email protected]