Skip to content

add scripts and description how to test plugins locally #1601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nyagami merged 2 commits into from
Mar 31, 2025
Merged

add scripts and description how to test plugins locally #1601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1350cc2
add scripts and description how to test plugins locally
eEQK Mar 30, 2025
9483a9b
add serve as an explicit dependency
eEQK Mar 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .env.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Override the default user content base path
# Default when empty: https://raw.githubusercontent.com/${USERNAME}/${REPO}/${CURRENT_BRANCH}
#
# for android emulator use 10.0.2.2
# for iOS simulator use 127.0.0.1 or localhost
# for a real device use the IP address of your computer in the local network (e.g. 192.168.21.37)
USER_CONTENT_BASE=http://localhost:3000
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ src/plugins/*/*\[*\]*.ts
dist
total.svg
src/plugins/index.ts
.history
.history
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,13 @@ Repository to host plugins and related issues, and requests for

#### via an app

1. Run `npm run host-linux` or `npm run host-windows` (depending on your operating system)
2. Add your `https://raw.githubusercontent.com/<username>/<repo>/plugins/<tag>/.dist/plugins.min.json` to app repository
1. Plugins from GitHub
* Run `npm run host-linux` or `npm run host-windows` (depending on your operating system)
* Add your `https://raw.githubusercontent.com/<username>/<repo>/plugins/<tag>/.dist/plugins.min.json` to app repository
2. Plugins from localhost
* Copy `.env.template` to `.env` and update `USER_CONTENT_BASE` according to the comment there
* Run `npm run host-dev`
* Add plugin listing to app repository (e.g. for android emulator `http://10.0.2.2/.dist/plugins.min.json`)

---

Expand Down
Loading