https://github.com/zbdpay/zbd-next-starter-playground
ZBD Next.js Starter Playground
https://github.com/zbdpay/zbd-next-starter-playground
api bitcoin lightning-network payments playground
Last synced: about 1 year ago
JSON representation
ZBD Next.js Starter Playground
- Host: GitHub
- URL: https://github.com/zbdpay/zbd-next-starter-playground
- Owner: zbdpay
- Created: 2023-04-19T02:14:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-02T02:17:02.000Z (almost 3 years ago)
- Last Synced: 2025-06-16T18:27:59.067Z (about 1 year ago)
- Topics: api, bitcoin, lightning-network, payments, playground
- Language: JavaScript
- Homepage: https://nextjs.zbd.dev
- Size: 198 KB
- Stars: 13
- Watchers: 7
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ZBD Next.js Dev Playground
Developer Playground for testing the ZBD API
[](https://zebedee.io)
[](https://github.com/zebedeeio/zbd-next-starter-playground/blob/HEAD/LICENSE.md) [](https://github.com/zebedeeio/zbd-next-starter-playground/blob/HEAD/CONTRIBUTING.md#pull-requests)
---
This is a starter kit for building fullstack applications using Next.js react framework alongside ZBD for global instantaneous Bitcoin payments.
This starter kit also emcompasses a Dev Playground (see `/pages/playground.js`) where ZBD-enabled modules can be used / tested.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fzebedeeio%2Fnextjs-zebedee-starter&env=ZBD_API_KEY&envDescription=Your%20ZBD%20project%20API%20key&demo-title=ZBD%20%2B%20Next.js%20Starter&demo-description=Starter%20kit%20for%20using%20ZBD%20API%20with%20Next.js%20fullstack%20applications&demo-url=https%3A%2F%2Fnextjs-zebedee-starter.vercel.app%2F&demo-image=https%3A%2F%2Fi.imgur.com%2FNf8wRgv.png)
## Installation & Setup
First you must install the project's dependencies:
```bash
npm run dev
# or
yarn dev
```
Then you must create a `.env.local` file in the root directory with your ZBD API key, like so:
```bash
ZBD_API_KEY=xxxxxxxxxxxxxxxx
```
You may also simply rename the `.env.local.example` file to `.env.local`.
That's it! You're all set.
## Starting Dev Server
To start the dev server run:
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## File Structure
You can start editing the project page by modifying `pages/index.js`. There is additional comments throughout this file as well. The page should auto-update as you edit the file. Any JS page inside of `pages` are treated as React components that can be rendered on the application.
Specifically, check out `/pages/index.js` and `/pages/playground.js` as they are the two main pages available in this starter kit.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) and effectively make up your project's backend APIs. The backend API is using the [`@zbd/node`](https://github.com/zebedeeio/zbd-node) SDK library for Node.js to interact with the ZBD API.
The main goal for this starter kit is to provide ample resources around source code that can be used to speed up your development of ZBD-powered applications.
## Learn More
To learn more about ZBD, take a look at the following resources:
- [ZBD Documentation Portal](https://docs.zebedee.io) - documentation, guides, and walkthroughs
- [GitHub](https://github.com/zebedeeio) - ZBD's org GitHub account with lots of example source code and open source SDK libraries
- [Discord Dev Chat](https://discord.gg/zbd) - join other developers discussing ZBD integration topics
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
## Deploy on Vercel
To make the most out of this Playground, deploy the project to Vercel using the Deploy button below and pass your ZBD API Key in the settings. This will spin up an instance of the Dev Playground connected to YOUR ZBD account.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fzebedeeio%2Fnextjs-zebedee-starter&env=ZBD_API_KEY&envDescription=Your%20ZBD%20project%20API%20key&demo-title=ZBD%20%2B%20Next.js%20Starter&demo-description=Starter%20kit%20for%20using%20ZBD%20API%20with%20Next.js%20fullstack%20applications&demo-url=https%3A%2F%2Fnextjs-zebedee-starter.vercel.app%2F&demo-image=https%3A%2F%2Fi.imgur.com%2FNf8wRgv.png)
