{"id":29007166,"url":"https://github.com/zbdpay/zbd-next-starter-playground","last_synced_at":"2025-06-25T13:05:01.088Z","repository":{"id":160119026,"uuid":"629775973","full_name":"zbdpay/zbd-next-starter-playground","owner":"zbdpay","description":"ZBD Next.js Starter Playground","archived":false,"fork":false,"pushed_at":"2023-08-02T02:17:02.000Z","size":203,"stargazers_count":13,"open_issues_count":1,"forks_count":7,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-06-16T18:27:59.067Z","etag":null,"topics":["api","bitcoin","lightning-network","payments","playground"],"latest_commit_sha":null,"homepage":"https://nextjs.zbd.dev","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zbdpay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-19T02:14:04.000Z","updated_at":"2025-05-08T23:31:19.000Z","dependencies_parsed_at":"2025-06-16T18:28:14.837Z","dependency_job_id":"18e1c669-ceac-4d77-bd80-ecce041fb9f6","html_url":"https://github.com/zbdpay/zbd-next-starter-playground","commit_stats":null,"previous_names":["zebedeeio/zbd-next-starter-playground","zbdpay/zbd-next-starter-playground"],"tags_count":4,"template":true,"template_full_name":null,"purl":"pkg:github/zbdpay/zbd-next-starter-playground","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbdpay%2Fzbd-next-starter-playground","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbdpay%2Fzbd-next-starter-playground/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbdpay%2Fzbd-next-starter-playground/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbdpay%2Fzbd-next-starter-playground/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zbdpay","download_url":"https://codeload.github.com/zbdpay/zbd-next-starter-playground/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbdpay%2Fzbd-next-starter-playground/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261879273,"owners_count":23223737,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bitcoin","lightning-network","payments","playground"],"created_at":"2025-06-25T13:05:00.217Z","updated_at":"2025-06-25T13:05:01.068Z","avatar_url":"https://github.com/zbdpay.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align='center'\u003eZBD Next.js Dev Playground\u003c/h1\u003e\n\n\u003cdiv align='center'\u003e\n\u003cimg width='900' src='https://i.imgur.com/AO87Pz0.png' /\u003e\n\u003c/div\u003e\n\n\u003cdiv align='center'\u003e\n\nDeveloper Playground for testing the ZBD API\n\n\u003cbr /\u003e\n\n[![bitcoin ln payments](https://img.shields.io/badge/Bitcoin%20Lightning-Payments-orange?style=for-the-badge\u0026logo=bitcoin)](https://zebedee.io)\n\u003cbr/\u003e\n\n[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zebedeeio/zbd-next-starter-playground/blob/HEAD/LICENSE.md) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/zebedeeio/zbd-next-starter-playground/blob/HEAD/CONTRIBUTING.md#pull-requests)\n\n\u003cbr /\u003e\n\n\n\u003cp align='center'\u003e\n  \u003ca href='https://nextjs.zbd.dev'\u003e\u003cstrong\u003eLive Dev Playground\u003c/strong\u003e\u003c/a\u003e · \u003ca href='https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fzebedeeio%2Fnextjs-zebedee-starter\u0026env=ZBD_API_KEY\u0026envDescription=Your%20ZBD%20project%20API%20key\u0026demo-title=ZBD%20%2B%20Next.js%20Starter\u0026demo-description=Starter%20kit%20for%20using%20ZBD%20API%20with%20Next.js%20fullstack%20applications\u0026demo-url=https%3A%2F%2Fnextjs-zebedee-starter.vercel.app%2F\u0026demo-image=https%3A%2F%2Fi.imgur.com%2FNf8wRgv.png'\u003e\u003cstrong\u003e1-Click Deploy\u003c/strong\u003e\u003c/a\u003e · \u003ca href='https://dashboard.zebedee.io'\u003e\u003cstrong\u003eDeveloper Dashboard\u003c/strong\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c/div\u003e\n\n---\n\n\u003cdiv align='left'\u003e\n\u003cbr /\u003e\n\nThis is a starter kit for building fullstack applications using Next.js react framework alongside ZBD for global instantaneous Bitcoin payments. \n\nThis starter kit also emcompasses a Dev Playground (see `/pages/playground.js`) where ZBD-enabled modules can be used / tested. \n\n![ ](https://i.imgur.com/3WqkI62.png)\n\n\u003cdiv align='center'\u003e\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fzebedeeio%2Fnextjs-zebedee-starter\u0026env=ZBD_API_KEY\u0026envDescription=Your%20ZBD%20project%20API%20key\u0026demo-title=ZBD%20%2B%20Next.js%20Starter\u0026demo-description=Starter%20kit%20for%20using%20ZBD%20API%20with%20Next.js%20fullstack%20applications\u0026demo-url=https%3A%2F%2Fnextjs-zebedee-starter.vercel.app%2F\u0026demo-image=https%3A%2F%2Fi.imgur.com%2FNf8wRgv.png)\n\n\u003c/div\u003e\n\n\n## Installation \u0026 Setup\n\nFirst you must install the project's dependencies:\n\n```bash\nnpm run dev\n# or\nyarn dev\n```\n\nThen you must create a `.env.local` file in the root directory with your ZBD API key, like so:\n\n```bash\nZBD_API_KEY=xxxxxxxxxxxxxxxx\n```\n\nYou may also simply rename the `.env.local.example` file to `.env.local`.\n\nThat's it! You're all set.\n\n## Starting Dev Server\n\nTo start the dev server run:\n\n```bash\nnpm run dev\n# or\nyarn dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) with your browser to see the result.\n\n## File Structure\n\nYou 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. \n\nSpecifically, check out `/pages/index.js` and `/pages/playground.js` as they are the two main pages available in this starter kit.\n\nThe `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.\n\nThe 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.\n\n## Learn More\n\nTo learn more about ZBD, take a look at the following resources:\n\n- [ZBD Documentation Portal](https://docs.zebedee.io) - documentation, guides, and walkthroughs\n- [GitHub](https://github.com/zebedeeio) - ZBD's org GitHub account with lots of example source code and open source SDK libraries\n- [Discord Dev Chat](https://discord.gg/zbd) - join other developers discussing ZBD integration topics\n\nTo learn more about Next.js, take a look at the following resources:\n\n- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.\n- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.\n\n## Deploy on Vercel\n\nTo 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.\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fzebedeeio%2Fnextjs-zebedee-starter\u0026env=ZBD_API_KEY\u0026envDescription=Your%20ZBD%20project%20API%20key\u0026demo-title=ZBD%20%2B%20Next.js%20Starter\u0026demo-description=Starter%20kit%20for%20using%20ZBD%20API%20with%20Next.js%20fullstack%20applications\u0026demo-url=https%3A%2F%2Fnextjs-zebedee-starter.vercel.app%2F\u0026demo-image=https%3A%2F%2Fi.imgur.com%2FNf8wRgv.png)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzbdpay%2Fzbd-next-starter-playground","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzbdpay%2Fzbd-next-starter-playground","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzbdpay%2Fzbd-next-starter-playground/lists"}