rsnext/examples/cloudflare-turnstile
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
pages add Cloudflare Turnstile example (#41283) 2022-10-12 12:56:37 +00:00
.env.local.example add Cloudflare Turnstile example (#41283) 2022-10-12 12:56:37 +00:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
app.css add Cloudflare Turnstile example (#41283) 2022-10-12 12:56:37 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
next.config.js add Cloudflare Turnstile example (#41283) 2022-10-12 12:56:37 +00:00
package.json add Cloudflare Turnstile example (#41283) 2022-10-12 12:56:37 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
tsconfig.json add Cloudflare Turnstile example (#41283) 2022-10-12 12:56:37 +00:00

Example with Cloudflare Turnstile

Turnstile is Cloudflares smart CAPTCHA alternative. It can be embedded into any website without sending traffic through Cloudflare and works without showing visitors a CAPTCHA.

This example shows how you can use Cloudflare Turnstile with your Next.js project. You can see a live version here.

Deploy your own

Deploy the example using Vercel.

Deploy with Vercel

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

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example cloudflare-turnstile cloudflare-turnstile-app
yarn create next-app --example cloudflare-turnstile cloudflare-turnstile-app
pnpm create next-app --example cloudflare-turnstile cloudflare-turnstile-app

Deploy it to the cloud with Vercel (Documentation).

Configuring Cloudflare Turnstile

Get a sitekey and secret key

  1. Go to the Cloudflare dashboard and select your account.
  2. Go to Turnstile.
  3. Select Add a site and fill out the form.
  4. Copy your Site Key and Secret Key.

Set up environment variables

To connect the app with Cloudflare Turnstile, you'll need to add the settings from your Cloudflare dashboard as environment variables

Copy the .env.local.example file in this directory to .env.local.

cp .env.local.example .env.local

Then, open .env.local and fill these environment variables:

  • NEXT_PUBLIC_CLOUDFLARE_TURNSTILE_SITE_KEY
  • CLOUDFLARE_TURNSTILE_SECRET_KEY