Upstash Examples
A collection of examples to show how to use Upstash with different technologies.
These examples will automatically be featured on our website and will be used in our documentation.
Contributing
We love our contributors! Here's how you can contribute:
- Open an issue if you believe you've encountered a bug.
- Make a pull request to add new examples/make quality-of-life improvements/fix bugs.
Adding an example
You can add a new example by creating a directory inside /examples.
Please give the directory a descriptive name, it should include the product used and the most relevant tech and/or usecase.
To create an example, you can create an app inside this folder, for example via npm create-next-app ... or similar and make the necessary changes to the code.
README.md
Please ensure you update the README.md with the necessary metadata, an explanation of what it does and instructions on how to run the example.
The metadata needs be in the following format at the very top of the README:
---
title: The name of the example
products: ["redis", "kafka", "qstash"]
stack: ["Next.js", "Vercel", "Supabase", "Deno"]
use_cases: ["Caching", "Ratelimiting"]
author: "your_github_username"
---An example for the the README can be found here
.env
Almost all examples will need some sort of secret to run, for example a Redis url or token. Please make sure your example includes a .env.example file with the necessary environment variable names. For example:
UPSTASH_REDIS_REST_URL=""
UPSTASH_REDIS_REST_TOKEN=""