Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mirumee/nimara-ecommerce

Top-notch headless e-commerce storefront built with Next.js and Typescript, powered by Saleor.
https://github.com/mirumee/nimara-ecommerce

commerce composable ecommerce global graphql multichannel nextjs nextjs14 radix-ui react saleor shadcn shadcn-ui starter-kit storefront tailwindcss turborepo typescript

Last synced: 15 days ago
JSON representation

Top-notch headless e-commerce storefront built with Next.js and Typescript, powered by Saleor.

Host: GitHub
URL: https://github.com/mirumee/nimara-ecommerce
Owner: mirumee
License: bsd-3-clause
Created: 2024-09-18T11:15:56.000Z (about 2 months ago)
Default Branch: main
Last Pushed: 2024-10-24T14:31:38.000Z (24 days ago)
Last Synced: 2024-10-25T04:51:47.004Z (23 days ago)
Topics: commerce, composable, ecommerce, global, graphql, multichannel, nextjs, nextjs14, radix-ui, react, saleor, shadcn, shadcn-ui, starter-kit, storefront, tailwindcss, turborepo, typescript
Language: TypeScript
Homepage: https://www.nimara.store
Size: 1.15 MB
Stars: 18
Watchers: 7
Forks: 3
Open Issues: 12
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

    

    

  





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








[![Nimara Demo](https://img.shields.io/badge/Nimara%20Demo-4CAF50?style=for-the-badge&logo=https://github.com/user-attachments/assets/1cef5626-94f3-4897-be6e-b5d73895b96b&logoWidth=30)](https://nimara.store)

[![Join Discord](https://img.shields.io/badge/Join%20Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/w4V3PZxGDj)

[![View Documentation](https://img.shields.io/badge/View%20Docs-24292e?style=for-the-badge&logo=github&logoColor=white)](https://nimara-docs.vercel.app/)



## 🎥 Demo



[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmirumee%2Fnimara-ecommerce&env=NEXT_PUBLIC_DEFAULT_CHANNEL,NEXT_PUBLIC_SALEOR_API_URL,SALEOR_APP_TOKEN,AUTH_SECRET,NEXT_PUBLIC_STRIPE_PUBLIC_KEY,STRIPE_SECRET_KEY,NEXT_PUBLIC_ENVIRONMENT,NEXT_PUBLIC_PAYMENT_APP_ID&project-name=my-nimara-storefront)



## 🚀 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](https://shadcn.com/ui) and [Tailwind CSS](https://tailwindcss.com/), providing a modern and customizable design system.

- **Turborepo:** Nimara's monorepo is powered by [Turborepo](https://turbo.build/repo/docs/getting-started/introduction), a fast and scalable build system for monorepos. Automated tests with [Playwright](https://playwright.dev/), [Storybook](https://storybook.js.org/) for UI development, and setup for [Docs](https://nextra.site/) are included.

- **Stripe Integration:** Nimara's storefront uses Stripe [Payment Element](https://docs.stripe.com/payments/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](https://pnpm.io/installation) and [Turborepo](https://turbo.build/repo/docs/installing), so make sure you have them installed globally in your system:

```bash

npm install -g pnpm

```

```bash

pnpm install turbo --global

```

## ⚡ Quickstart

Clone this repository and copy `.env.example` to `.env`:

```bash

cp .env.example .env

```

Edit `.env` file and provide required variables.

Then, [install `pnpm`](https://pnpm.io/installation) and run the following command to install all dependencies in the repo:

```bash

pnpm i

```

To start just the development server for storefront, run this

```bash

pnpm run dev:storefront

```

To generate a new types, run this:

```bash

pnpm run codegen

```

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

## ❤️ Community & Contribution

Join Nimara community on [GitHub Discussions](https://github.com/mirumee/nimara-ecommerce/discussions) and [Discord server](https://discord.gg/w4V3PZxGDj). You can ask questions, report bugs, participate in discussions, share ideas or make feature requests.

You can also contribute to Nimara in various ways:

- Report [issues](https://github.com/mirumee/nimara-ecommerce/issues/new?assignees=srinivaspendem%2Cpushya22&labels=%F0%9F%90%9Bbug&projects=&template=--bug-report.yaml&title=%5Bbug%5D%3A+) and suggest [new features](https://github.com/mirumee/nimara-ecommerce/issues/new?assignees=srinivaspendem%2Cpushya22&labels=%E2%9C%A8feature&projects=&template=--feature-request.yaml&title=%5Bfeature%5D%3A+).

- Review [documentation](https://nimara-docs.vercel.app/) and submit [pull requests](https://github.com/mirumee/nimara-ecommerce/pulls)—whether it's fixing typos or adding new features.

- Share your experiences or projects related to Nimara with the broader community through talks or blog posts.

- Support [popular feature requests](https://github.com/mirumee/nimara-ecommerce/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) by upvoting them.

### This wouldn't have been possible without your support



  






 Crafted with ❤️ by Mirumee Software

[[email protected]](mailto:[email protected])