A starter template for developers to build new LNbits extensions with a clean, well-structured foundation.
This repository provides a ready-to-use extension skeleton that follows LNbits conventions and best practices, making it easier to build, test, and maintain custom extensions.
This template is designed to:
- Serve as a clonable base structure for new LNbits extensions
- Demonstrate recommended LNbits extension patterns
- Reduce setup time for new extension projects
- Encourage consistency across the LNbits extension ecosystem
It is the recommended starting point if you want to develop your own LNbits extension with proper structure and conventions.
The template includes:
- Example extension layout (backend + frontend)
- Sample database models
- Example API endpoints
- Configuration and metadata files
- Support for symbolic linking to simplify local development
- Clear separation of logic, views, and API routes
All components are intentionally minimal and meant to be adapted or extended.
If your extension exposes API endpoints, document them clearly.
Below is a simple example request pattern:
curl -H "Content-type: application/json" \
-H "X-Api-Key: YOUR_WALLET_ADMIN_OR_INVOICE_KEY" \
-X POST https://YOUR-LNBITS/YOUR-EXTENSION/api/v1/example \
-d '{"amount": 100, "memo": "example"}'
Replace the endpoint, payload, and permissions according to your extension logic.
- This template supports symbolic linking for local LNbits development setups
- Intended for developers familiar with LNbits and its extension system
- You are expected to modify, remove, or extend all example logic
If you are using LLMs to generate code, please make sure to follow the official LNbits instructions when configuring your model to avoid insecure or incompatible output.
- LNbits core repository: https://github.com/lnbits/lnbits
- Extension documentation: https://github.com/lnbits/lnbits/wiki/LNbits-Extensions
- Official website: https://lnbits.com
LNbits is a free and open-source Lightning accounts system.
