Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stripe-archive/nextjs-typescript-react-stripe-js

Full-stack TypeScript example using Next.js, react-stripe-js, and stripe-node.
https://github.com/stripe-archive/nextjs-typescript-react-stripe-js

react-stripe-js stripe-checkout stripe-elements typescript

Last synced: 4 days ago
JSON representation

Full-stack TypeScript example using Next.js, react-stripe-js, and stripe-node.

Host: GitHub
URL: https://github.com/stripe-archive/nextjs-typescript-react-stripe-js
Owner: stripe-archive
License: mit
Archived: true
Created: 2020-02-13T15:18:39.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-02-02T17:44:04.000Z (almost 3 years ago)
Last Synced: 2024-08-01T22:53:53.065Z (3 months ago)
Topics: react-stripe-js, stripe-checkout, stripe-elements, typescript
Language: TypeScript
Homepage: https://nextjs-typescript-react-stripe-js.now.sh/
Size: 4.79 MB
Stars: 328
Watchers: 7
Forks: 65
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        > 

>

> This project is deprecated and is no longer being actively maintained.

>

> See [vercel/next.js/examples/with-stripe-typescript](https://github.com/vercel/next.js/tree/canary/examples/with-stripe-typescript) for an alternative sample.

# Sample using Next.js, TypeScript, and react-stripe-js 🔒💸

This is a full-stack TypeScript example using:

- Frontend:

  - Next.js and [SWR](https://github.com/zeit/swr)

  - [react-stripe-js](https://github.com/stripe/react-stripe-js) for [Checkout](https://stripe.com/checkout) and [Elements](https://stripe.com/elements)

- Backend

  - Next.js [API routes](https://nextjs.org/docs/api-routes/introduction)

  - [stripe-node with TypeScript](https://github.com/stripe/stripe-node#usage-with-typescript)

## Demo

- Live demo: https://nextjs-typescript-react-stripe-js.now.sh/

- CodeSandbox: https://codesandbox.io/s/github/stripe-samples/nextjs-typescript-react-stripe-js

- Tutorial: https://dev.to/thorwebdev/type-safe-payments-with-next-js-typescript-and-stripe-4jo7

The demo is running in test mode -- use `4242424242424242` as a test card number with any CVC + future expiration date.

Use the `4000000000003220` test card number to trigger a 3D Secure challenge flow.

Read more about testing on Stripe at https://stripe.com/docs/testing.

Shopping Cart Checkout Demo



Checkout Donations Demo



Elements Donations Demo



## Deploy your own

Once you have access to [the environment variables you'll need](#required-configuration) from the [Stripe Dashboard](https://dashboard.stripe.com/apikeys), deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):

[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/select-scope?c=1&s=https://github.com/vercel/next.js/tree/canary/examples/with-stripe-typescript&id=70107786&env=NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY,STRIPE_SECRET_KEY&envDescription=Enter%20your%20Stripe%20Keys&envLink=https://github.com/vercel/next.js/tree/canary/examples/with-stripe-typescript%23required-configuration)

## Included functionality

- [Global CSS styles](https://nextjs.org/blog/next-9-2#built-in-css-support-for-global-stylesheets)

- Implementation of a Layout component that loads and sets up Stripe.js and Elements for usage with SSR via `loadStripe` helper: [components/Layout.tsx](components/Layout.tsx).

- Stripe Checkout

  - Custom Amount Donation with redirect to Stripe Checkout:

    - Frontend: [pages/donate-with-checkout.tsx](pages/donate-with-checkout.tsx)

    - Backend: [pages/api/checkout_sessions/](pages/api/checkout_sessions/)

    - Checkout payment result page that uses [SWR](https://github.com/zeit/swr) hooks to fetch the CheckoutSession status from the API route: [pages/result.tsx](pages/result.tsx).

- Stripe Elements

  - Custom Amount Donation with Stripe Elements & PaymentIntents (no redirect):

    - Frontend: [pages/donate-with-elements.tsx](pages/donate-with-checkout.tsx)

    - Backend: [pages/api/payment_intents/](pages/api/payment_intents/)

- Webhook handling for [post-payment events](https://stripe.com/docs/payments/accept-a-payment#web-fulfillment)

  - By default Next.js API routes are same-origin only. To allow Stripe webhook event requests to reach our API route, we need to add `micro-cors` and [verify the webhook signature](https://stripe.com/docs/webhooks/signatures) of the event. All of this happens in [pages/api/webhooks/index.ts](pages/api/webhooks/index.ts).

- Helpers

  - [utils/api-helpers.ts](utils/api-helpers.ts)

    - helpers for GET and POST requests.

  - [utils/stripe-helpers.ts](utils/stripe-helpers.ts)

    - Format amount strings properly using `Intl.NumberFormat`.

    - Format amount for usage with Stripe, including zero decimal currency detection.

## How to use

### Using `create-next-app`

Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:

```bash

npx create-next-app --example with-stripe-typescript with-stripe-typescript-app

# or

yarn create next-app --example with-stripe-typescript with-stripe-typescript-app

```

### Download manually

Download the example:

```bash

curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-stripe-typescript

cd with-stripe-typescript

```

### Required configuration

Copy the `.env.local.example` file into a file named `.env.local` in the root directory of this project:

```bash

cp .env.local.example .env.local

```

You will need a Stripe account ([register](https://dashboard.stripe.com/register)) to run this sample. Go to the Stripe [developer dashboard](https://stripe.com/docs/development/quickstart#api-keys) to find your API keys and replace them in the `.env.local` file.

```bash

NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=

STRIPE_SECRET_KEY=

```

Now install the dependencies and start the development server.

```bash

npm install

npm run dev

# or

yarn

yarn dev

```

### Forward webhooks to your local dev server

First [install the CLI](https://stripe.com/docs/stripe-cli) and [link your Stripe account](https://stripe.com/docs/stripe-cli#link-account).

Next, start the webhook forwarding:

```bash

stripe listen --forward-to localhost:3000/api/webhooks

```

The CLI will print a webhook secret key to the console. Set `STRIPE_WEBHOOK_SECRET` to this value in your `.env.local` file.

### Setting up a live webhook endpoint

After deploying, copy the deployment URL with the webhook path (`https://your-url.now.sh/api/webhooks`) and create a live webhook endpoint [in your Stripe dashboard](https://stripe.com/docs/webhooks/setup#configure-webhook-settings).

Once created, you can click to reveal your webhook's signing secret. Copy the webhook secret (`whsec_***`) and add it as a new environment variable in your [Vercel Dashboard](https://vercel.com/dashboard):

- Select your newly created project.

- Navigate to the Settings tab.

- In the general settings scroll to the "Environment Variables" section.

After adding an environment variable you will need to rebuild your project for it to become within your code. Within your project Dashboard, navigate to the "Deployments" tab, select the most recent deployment, click the overflow menu button (next to the "Visit" button) and select "Redeploy".

### Deploy on Vercel

You can deploy this app to the cloud with [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).

#### Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and [import to Vercel](https://vercel.com/import/git?utm_source=github&utm_medium=readme&utm_campaign=next-example).

**Important**: When you import your project on Vercel, make sure to click on **Environment Variables** and set them to match your `.env.local` file.

#### Deploy from Our Template

Alternatively, you can deploy using our template by clicking on the Deploy button below.

[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/select-scope?c=1&s=https://github.com/vercel/next.js/tree/canary/examples/with-stripe-typescript&id=70107786&env=NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY,STRIPE_SECRET_KEY&envDescription=Enter%20your%20Stripe%20Keys&envLink=https://github.com/vercel/next.js/tree/canary/examples/with-stripe-typescript%23required-configuration)

## Get support

If you found a bug or want to suggest a new [feature/use case/sample], please [file an issue](../../issues).

If you have questions, comments, or need help with code, we're here to help:

- on [Discord](https://stripe.com/go/developer-chat)

- on Twitter at [@StripeDev](https://twitter.com/StripeDev)

- on Stack Overflow at the [stripe-payments](https://stackoverflow.com/tags/stripe-payments/info) tag

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

Sign up to [stay updated with developer news](https://go.stripe.global/dev-digest).

## Authors

- [@thorsten-stripe](https://twitter.com/thorwebdev)

- [@lfades](https://twitter.com/luis_fades)