mirrors/decky-plugin-template
1
0
Fork 0
mirror of https://github.com/SteamDeckHomebrew/decky-plugin-template.git synced 2025-10-29 06:22:25 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add README, tasks, moved to pnpm and added an ignore for react (#3)

Browse source
This commit is contained in:
TrainDoctor 2022-06-14 13:38:29 -07:00 • committed by GitHub
commit d67d18ab77
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 999 additions and 2530 deletions
Download patch file Download diff file Expand all files Collapse all files

37
README.md Normal file
View file

@ -0,0 +1,37 @@
# React-Frontend Plugin Template
Reference example for using [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) in a [PluginLoader](https://github.com/SteamDeckHomebrew/PluginLoader) plugin.
## PluginLoader Discord [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/ZU74G2NJzk)
## Developers
### Dependencies
This template relies on the user having `pnpm` installed on their system.
This can be downloaded from `npm` itself which is recommended.
#### Linux
```bash
sudo npm i -g pnpm
```
### Getting Started
1. Clone the repository to use as an example for making your plugin.
2. In your clone of the repository run these commands:
1. ``pnpm i``
2. ``pnpm run build``
3. You should do this every time you make changes to your plugin.
Note: If you are recieveing build errors due to an out of date library, you should run this command inside of your repository:
```bash
pnpm update decky-frontend-lib --latest
```
### Distribution
WIP. Check back in later.