https://github.com/lnbits/myextension

https://github.com/lnbits/myextension

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/lnbits/myextension
• Owner: lnbits
• License: other
• Created: 2023-12-08T15:43:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-13T22:21:43.000Z (over 1 year ago)
• Last Synced: 2025-02-13T23:29:11.235Z (over 1 year ago)
• Language: Python
• Size: 245 KB
• Stars: 2
• Watchers: 4
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
`The README.md typically serves as a guide for using the extension.`

# MyExtension - An [LNbits](https://github.com/lnbits/lnbits) Extension

## A Starter Template for Your Own Extension

Ready to start hacking? Once you've forked this extension, you can incorporate functions from other extensions as needed.

### How to Use This Template

> This guide assumes you're using this extension as a base for a new one, and have installed LNbits using https://github.com/lnbits/lnbits/blob/main/docs/guide/installation.md#option-1-recommended-poetry.

1. Install and enable the extension either through the official LNbits manifest or by adding https://raw.githubusercontent.com/lnbits/myextension/main/manifest.json to `"Server"/"Server"/"Extension Sources"`. ![Extension Sources](https://i.imgur.com/MUGwAU3.png) ![image](https://github.com/lnbits/myextension/assets/33088785/4133123b-c747-4458-ba6c-5cc7c0f124d8)

2. `Ctrl c` shut down your LNbits installation.

3. Download the extension files from https://github.com/lnbits/myextension to a folder outside of `/lnbits`, and initialize the folder with `git`. Alternatively, create a repo, copy the myextension extension files into it, then `git clone` the extension to a location outside of `/lnbits`.

4. Remove the installed extension from `lnbits/lnbits/extensions`.

5. Create a symbolic link using `ln -s /home/ben/Projects/ /home/ben/Projects/lnbits/lnbits/extensions`.

6. Restart your LNbits installation. You can now modify your extension and `git push` changes to a repo.

7. When you're ready to share your manifest so others can install it, edit `/lnbits/myextension/manifest.json` to include the git credentials of your extension.

8. IMPORTANT: If you want your extension to be added to the official LNbits manifest, please follow the guidelines here: https://github.com/lnbits/lnbits-extensions#important