Skip to content

Home

Jump to bottom
chris edited this page May 18, 2023 · 13 revisions

🚀**A Redwood/Stripe integration made easy!**🚀

The aim of this plugin is to allow users to create a commerce site with minimal configuration. After running the setup command users will have a demo storefront generated into their app which uses a simple cart machine for cart items and uses Stripe Checkout to checkout. The demo store can either be customised by the user or used as documentation for building their own storefront.

Current features:

  • Stripe Checkout via useStripeCheckout() hook
  • Subscription support via useStripeCustomerPortal() hook
  • LoFi persistent cart functionality via useStripeCart() hook
  • User mapping via <StripeProvider/>
  • Setup script to build a working demo npx @redwoodjs-stripe/cli setup
  • Schemas and services are imported from plugin. Barely any boilerplate needed
  • Demo store as in-app API reference

There's an example store that is bit more realistic in its application of the plugin if you need a slightly more complicated example.

Limitations

Majority of these will be fixed in upcoming releases.

  • Setup script will overwrite api/src/functions/graphql.js. This file is used to import the services and sdl from the plugin. If you have made changes to your file after creating your Redwoodjs app then you can either import the services and schemas manually and not run the setup script or rename your file temporarily then run the setup script.
import { stripeServices, stripeSchemas } from '@redwoodjs-stripe/api'
  • There's currently no Typescript support
  • There's no integration tests

🚀 Built with help from the awesome people at Redwood and Stripe 🚀

Resources

How you can help

Thank you

The teams from Stripe and RedwoodJS who have supported this project from day one.

Everybody else who contributed in code, pep talks and every other way!

Where to next?

Go over to the Quick Start guide to start playing around

Clone this wiki locally