tier-vercel-openai - GitLite

KO | EN

gitlite — search

#javascript #python #ai #llm #go #android #deep-learning #linux #windows #cli #security #ios #openai #open-source

tier-vercel-openai

(★ 338)

This project generates marketing content using OpenAI, implements metered pricing model, checks for feature access based on their current subscription, reports usage of a feature, manages subscription and more using Tier.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- CODEOWNERS
- pull_request_template.md
- commit-msg
- extensions.json
- settings.json
- _schemaprisma.planetscale
- _schemaprisma.supabase
- schema.prisma
- - android-chrome-192x192.png
  - android-chrome-512x512.png
  - apple-touch-icon.png
  - favicon-16x16.png
  - favicon-32x32.png
  - favicon.ico
  - icon.svg
  - site.webmanifest
- favicon-16x16.png
- favicon-32x32.png
- og.jpg
- - layout.tsx
  - opengraph-image.png
  - robots.ts
- - Footer.tsx
- - site.ts
  - tierConstants.ts
- - ai.ts
  - auth.ts
  - db.ts
  - fonts.ts
  - session.ts
  - tier-edge.ts
  - tier.ts
  - utils.ts
- - globals.css
- - index.d.ts
  - next-auth.d.ts
- env.mjs
- middleware.ts
.editorconfig
.env.example
.eslintrc.json
.gitignore
.infisical.json
.nvmrc
.prettierignore
CODE_OF_CONDUCT.md
commitlint.config.cjs
knip.json
LICENSE.md
migrate.mjs
next.config.mjs
package-lock.json
package.json
postcss.config.js
prettier.config.js
README.md
tailwind.config.js
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/tierrun/tier-vercel-openai

Downloads the entire project code from GitHub to your computer.

cd tier-vercel-openai

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm i

Type this command into your terminal and run it.

npm run dev

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Metered billing for an AI content creator app

![Blip - Metered billing based AI content creator app](https://raw.githubusercontent.com/tierrun/tier-vercel-openai/main/src/app/opengraph-image.png)

Get started with usage based billing for your OpenAI based apps!

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftierrun%2Ftier-vercel-openai&env=NEXT_PUBLIC_APP_URL,NEXTAUTH_SECRET,GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET,TIER_BASE_URL,TIER_API_KEY,OPENAI_API_KEY&envDescription=All%20the%20environment%20variables%20mentioned%20here%20are%20described%20in%20detail%20in%20this%20link.&envLink=https%3A%2F%2Fgithub.com%2Ftierrun%2Ftier-vercel-openai%23environment-variables&project-name=tier-vercel-openai&repository-name=tier-vercel-openai&demo-title=Metered%20billing%20for%20an%20AI%20content%20creator%20app&demo-description=This%20project%20generates%20marketing%20content%20using%20OpenAI%2C%20implements%20metered%20pricing%20model%2C%20checks%20for%20feature%20access%20based%20on%20their%20current%20subscription%2C%20reports%20usage%20of%20a%20feature%2C%20manages%20subscription%20and%20more%20using%20Tier.&demo-url=https%3A%2F%2Ftier-vercel-openai.vercel.app%2F&demo-image=https%3A%2F%2Ftier-vercel-openai.vercel.app%2Fog.jpg&install-command=npm%20install&stores=%5B%7B"type"%3A"postgres"%7D%5D&)

This project generates marketing content using OpenAI, implements metered pricing model, checks for feature access based on their current subscription, reports usage of a feature, manages subscription and more using Tier.

## Demo

- https://tier-vercel-openai.vercel.app/

## Features

- NextJS 13 `/app` dir
- AI content generation using **OpenAI**
- Pricing using **[Tier](<(https://tier.run)>)** and Stripe.
  - Pricing model using Tier Model Builder
  - Subscriptions and Checkout
  - Feature access and upsells
  - Reporting usage of a feature
  - Pricing table
  - Customer billing portal
- Authentication using Auth.js
- ORM using **Prisma**
- Database on **Vercel Postgres (Default)** / **Planetscale** / **Supabase**

## Why Tier?

Tier decouples billing, metering, and access checks from your application code. With it, you can conveniently establish new pricing models without needing to restructure your app or concern yourself with grandfathering or breaking changes.

## Running locally

1. Install dependencies

```bash
npm i
```

1. Copy `.env.example` to `.env.local` and update the variables.

```bash
cp .env.example .env.local
```

3. Run the project locally

```bash
npm run dev
```

## Tier Pricing Model

- Model Builder - https://model.tier.run/clkkv3fv93bbko972m4w3x9o8

You can clone the pricing model from the above links and make it your own. You can sync it with your Stripe "Test Mode" for both your dev and staging environments. You can also push this model to prod as shown below, by making use of the Tier CLI using this command where you use the model builder link and set a environment variable called `STRIPE_API_KEY` which should be a restricted key generated will all permissions in your Stripe live mode. You can find restricted keys at `Developers > API Keys > Restricted Keys`

```bash
tier --live push <https://models.tier.run/XXXXXXXX>
```

## Environment variables

We have considerably reduced the number of environment variables in the project to make it easier for you to get started. This is an exhaustive list of all the environment variables in the project

1. App: `NEXT_PUBLIC_APP_URL` - The is the URL of your application, if you are in the middle of using our deploy button for Vercel, you can open vercel dashboard in another window and visit https://vercel.com/jerric-tier/project-name/settings/domains by replacing `project-name` with yours, make sure to append `https://` to your domain. In local dev mode, you can set this variable in `env.local / env.development` and give it this value `http://localhost:3000`.
2. Auth: `NEXTAUTH_URL` - Used by [Auth.JS](https://authjs.dev/) - When deploying to vercel **you do not have to set this value**, but when you develop you can set this as `http://localhost:3000`. Find more details [here](https://next-auth.js.org/configuration/options#nextauth_url).
3. Auth: `NEXTAUTH_SECRET` - Used by [Auth.JS](https://authjs.dev/) - Used to encrypt JWT and you can easily generate a secret using `openssl rand -base64 32`. Find more details [here](https://next-auth.js.org/configuration/options#nextauth_secret).
4. Github OAuth: `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` - Both Client ID and Client Secret of Github App can be generated at your [Github Developer Settings](https://github.com/settings/developers) page and you can read the step-by-step directions [here](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app). You can provide your `NEXT_PUBLIC_APP_URL` as the Homepage URL and append `/api/auth/callback/github` for the callback URL
5. Tier: `TIER_BASE_URL` & `TIER_API_KEY` - You can set your `TIER_BASE_URL` variable as `https://api.tier.run` default value in all your environments and `TIER_API_KEY` is your Stripe secret key. You can follow the steps in our [docs](https://www.tier.run/docs/quickstarts/create-pricing-model#5-sync-with-stripe) to sync your pricing model with your Stripe account.
6. OpenAI: `OPENAI_API_KEY` - Get your OpenAI API key from [OpenAI User Settings](https://platform.openai.com/account/api-keys)
7. Vercel Storage: `POSTGRES_PRISMA_URL` & `POSTGRES_URL_NON_POOLING` - You will only need these two variables after you have setup your database as we are using Prisma. You can find more details [here](https://vercel.com/docs/storage/vercel-postgres/quickstart).

## Powered by

This example is powered by the following services:

- [Tier](https://tier.run) (Subscriptions and Pricing)
- [OpenAI](https://openai.com/) (AI API)
- [Vercel](https://vercel.com/) (Hosting NextJS)
- [Auth.js](https://authjs.dev/) (Auth)
- [Vercel Postgres (default)](https://vercel.com/storage/postgres) / [Supabase](https://supabase.com/) / [Planetscale](https://planetscale.com/) (Database)
- [Stripe](https://stripe.com/) (Payments)
- [Infisical](https://infisical.com/) (Secrets)

## License

License under the [MIT license](/LICENSE.md).