Penny

screenshot of Penny
nextjs
react
tailwind
headless-ui

Penny

Penny - A production-ready, next.js, composable commerce reference implementation, using TakeShape's API Mesh

Overview

The Penny E-commerce Starter Kit by TakeShape is an e-commerce solution that provides a comprehensive set of tools and services to build and deploy an online store. It offers features such as customer data management, product information, payment processing, identity management, security, customer support, newsletter subscriptions, product reviews, customer loyalty rewards, and shipping management. The frontend codebase is built using Next.js, TypeScript, Apollo Client, Jotai, Storybook, and Tailwind CSS. Continuous integration, unit tests, end-to-end tests, and performance tests are also supported.

Features

  • Unified GraphQL API that integrates with Shopify Admin and Storefront, OpenID, ReCAPTCHA, Gorgias, Klaviyo, REVIEWS.io, Trustpilot, Voucherify, and Ship Engine.
  • TakeShape's API Indexing for fast product queries and search.
  • TakeShape's ShapeDB for hosting custom content.
  • Next.js for building pages and bundling the frontend application.
  • NextAuth for user authentication against TakeShape and Shopify.
  • TypeScript for type safety and documentation.
  • Apollo Client for efficient GraphQL queries.
  • Jotai for optimized component state management.
  • Storybook for rapid UI prototyping and review.
  • Tailwind CSS for styling.

Installation

To install the Penny E-commerce Starter Kit, follow these steps:

  1. Clone the repository using the command git clone https://github.com/takeshape/penny.
  2. Deploy the pattern in the .takeshape/pattern directory to connect it to the GraphQL backend provided by TakeShape.
  3. Set up your lighthouse testing paths in .lighthouse/testPaths.json, with the homepage being tested by default.

Summary

The Penny E-commerce Starter Kit by TakeShape is a comprehensive solution for building and deploying e-commerce stores. It offers a unified GraphQL API that integrates with various services, including Shopify, OpenID, ReCAPTCHA, Gorgias, Klaviyo, REVIEWS.io, Trustpilot, Voucherify, and Ship Engine. The frontend codebase is built using Next.js, TypeScript, Apollo Client, Jotai, Storybook, and Tailwind CSS. Continuous integration, unit tests, end-to-end tests, and performance tests are supported to ensure code quality and performance. Overall, the Penny E-commerce Starter Kit provides a robust foundation for creating successful online stores.

nextjs
Next.js

Next.js is a React-based web framework that enables server-side rendering, static site generation, and other powerful features for building modern web applications.

react
React

React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components

tailwind
Tailwind

Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.

headless-ui
Headless UI

Headless UI is a set of completely unstyled, fully accessible UI components for React, Vue, and Alpine.js that empower developers to build their own fully accessible custom UI components. Headless UI allows developers to focus on building accessible and highly functional user interfaces, without the need to worry about styling or layout.

ecommerce
Ecommerce

Ecommerce websites sell products or services to customers through an online storefront. These websites typically include features such as product listings, shopping carts, payment processing, and order management tools.

apollo
Apollo

Apollo is an open-source platform for building GraphQL APIs that connects with any data source. It provides a powerful set of tools and features for developers, including client and server-side caching, real-time data synchronization, and a seamless integration with popular frontend frameworks.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

graphql
Graphql

A website that uses GraphQL as a query language to manage data fetching and state management. This includes features such as a strongly typed schema, client-side caching, and declarative data fetching to streamline data management and optimize website performance.

postcss
Postcss

PostCSS is a popular open-source tool that enables web developers to transform CSS styles with JavaScript plugins. It allows for efficient processing of CSS styles, from applying vendor prefixes to improving browser compatibility, ultimately resulting in cleaner, faster, and more maintainable code.

Storybook

Storybook is a tool for developing and testing UI components in isolation. It provides a sandbox environment where you can experiment with different props and states to see how your component responds.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.

webpack
Webpack

Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.