create-skybridge 0.0.0-dev.f561bc3 → 0.0.0-dev.f6bca06
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/index.js +164 -33
- package/dist/index.test.js +12 -6
- package/package.json +12 -13
- package/template/AGENTS.md +1 -0
- package/template/README.md +54 -21
- package/template/_gitignore +2 -1
- package/template/alpic.json +1 -2
- package/template/node_modules/.bin/alpic +21 -0
- package/template/node_modules/.bin/nodemon +21 -0
- package/template/node_modules/.bin/sb +21 -0
- package/template/node_modules/.bin/skybridge +21 -0
- package/template/node_modules/.bin/tsc +21 -0
- package/template/node_modules/.bin/tsserver +21 -0
- package/template/node_modules/.bin/tsx +21 -0
- package/template/node_modules/.bin/vite +21 -0
- package/template/nodemon.json +5 -0
- package/template/package.json +27 -10
- package/template/server/src/index.ts +62 -34
- package/template/tsconfig.json +23 -0
- package/template/tsconfig.server.json +11 -0
- package/template/web/src/helpers.ts +1 -1
- package/template/web/src/index.css +130 -6
- package/template/web/src/widgets/magic-8-ball.tsx +8 -3
- package/template/web/vite.config.ts +3 -3
- package/template/pnpm-workspace.yaml +0 -7
- package/template/server/nodemon.json +0 -5
- package/template/server/package.json +0 -34
- package/template/server/src/env.ts +0 -12
- package/template/server/src/middleware.ts +0 -54
- package/template/server/src/server.ts +0 -79
- package/template/server/tsconfig.json +0 -17
- package/template/web/package.json +0 -24
- package/template/web/tsconfig.app.json +0 -34
- package/template/web/tsconfig.json +0 -13
- package/template/web/tsconfig.node.json +0 -26
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Alpic
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.js
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
|
+
import { spawnSync } from "node:child_process";
|
|
1
2
|
import fs from "node:fs";
|
|
2
3
|
import path from "node:path";
|
|
3
4
|
import { fileURLToPath } from "node:url";
|
|
4
5
|
import * as prompts from "@clack/prompts";
|
|
6
|
+
import { downloadTemplate } from "giget";
|
|
5
7
|
import mri from "mri";
|
|
6
8
|
const defaultProjectName = "skybridge-project";
|
|
7
9
|
// prettier-ignore
|
|
@@ -12,21 +14,32 @@ Create a new Skybridge project by copying the starter template.
|
|
|
12
14
|
|
|
13
15
|
Options:
|
|
14
16
|
-h, --help show this help message
|
|
17
|
+
--repo <uri> use a git repository instead of the built-in template
|
|
15
18
|
--overwrite remove existing files in target directory
|
|
19
|
+
--immediate install dependencies and start development server
|
|
20
|
+
|
|
21
|
+
Repository URI formats:
|
|
22
|
+
github:user/repo
|
|
23
|
+
gitlab:user/repo/subdirectory
|
|
24
|
+
bitbucket:user/repo#branch
|
|
16
25
|
|
|
17
26
|
Examples:
|
|
18
27
|
create-skybridge my-app
|
|
19
|
-
create-skybridge
|
|
28
|
+
create-skybridge my-app --repo github:alpic-ai/skybridge/examples/ecom-carousel
|
|
29
|
+
create-skybridge . --overwrite --immediate
|
|
20
30
|
`;
|
|
21
31
|
export async function init(args = process.argv.slice(2)) {
|
|
22
32
|
const argv = mri(args, {
|
|
23
|
-
boolean: ["help", "overwrite"],
|
|
33
|
+
boolean: ["help", "overwrite", "immediate"],
|
|
34
|
+
string: ["repo"],
|
|
24
35
|
alias: { h: "help" },
|
|
25
36
|
});
|
|
26
37
|
const argTargetDir = argv._[0]
|
|
27
38
|
? sanitizeTargetDir(String(argv._[0]))
|
|
28
39
|
: undefined;
|
|
40
|
+
const argRepo = argv.repo;
|
|
29
41
|
const argOverwrite = argv.overwrite;
|
|
42
|
+
const argImmediate = argv.immediate;
|
|
30
43
|
const help = argv.help;
|
|
31
44
|
if (help) {
|
|
32
45
|
console.log(helpMessage);
|
|
@@ -43,13 +56,14 @@ export async function init(args = process.argv.slice(2)) {
|
|
|
43
56
|
defaultValue: defaultProjectName,
|
|
44
57
|
placeholder: defaultProjectName,
|
|
45
58
|
validate: (value) => {
|
|
46
|
-
return value
|
|
59
|
+
return !value || sanitizeTargetDir(value).length > 0
|
|
47
60
|
? undefined
|
|
48
61
|
: "Invalid project name";
|
|
49
62
|
},
|
|
50
63
|
});
|
|
51
|
-
if (prompts.isCancel(projectName))
|
|
64
|
+
if (prompts.isCancel(projectName)) {
|
|
52
65
|
return cancel();
|
|
66
|
+
}
|
|
53
67
|
targetDir = sanitizeTargetDir(projectName);
|
|
54
68
|
}
|
|
55
69
|
else {
|
|
@@ -77,8 +91,9 @@ export async function init(args = process.argv.slice(2)) {
|
|
|
77
91
|
},
|
|
78
92
|
],
|
|
79
93
|
});
|
|
80
|
-
if (prompts.isCancel(res))
|
|
94
|
+
if (prompts.isCancel(res)) {
|
|
81
95
|
return cancel();
|
|
96
|
+
}
|
|
82
97
|
overwrite = res;
|
|
83
98
|
}
|
|
84
99
|
else {
|
|
@@ -90,35 +105,132 @@ export async function init(args = process.argv.slice(2)) {
|
|
|
90
105
|
emptyDir(targetDir);
|
|
91
106
|
break;
|
|
92
107
|
case "no":
|
|
93
|
-
|
|
94
|
-
|
|
108
|
+
prompts.log.error("Target directory is not empty.");
|
|
109
|
+
process.exit(1);
|
|
95
110
|
}
|
|
96
111
|
}
|
|
97
112
|
const root = path.join(process.cwd(), targetDir);
|
|
98
|
-
// 3.
|
|
99
|
-
prompts.log.step(`Copying template...`);
|
|
113
|
+
// 3. Download from repo or copy template
|
|
100
114
|
try {
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
fs.
|
|
115
|
+
if (argRepo) {
|
|
116
|
+
prompts.log.step(`Downloading ${argRepo}...`);
|
|
117
|
+
await downloadTemplate(argRepo, { dir: root });
|
|
118
|
+
prompts.log.success(`Project created in ${root}`);
|
|
119
|
+
}
|
|
120
|
+
else {
|
|
121
|
+
prompts.log.step(`Copying template...`);
|
|
122
|
+
const templateDir = fileURLToPath(new URL("../template", import.meta.url));
|
|
123
|
+
// Copy template to target directory
|
|
124
|
+
fs.cpSync(templateDir, root, {
|
|
125
|
+
recursive: true,
|
|
126
|
+
filter: (src) => [".npmrc"].every((file) => !src.endsWith(file)),
|
|
127
|
+
});
|
|
128
|
+
// Rename _gitignore to .gitignore
|
|
129
|
+
fs.renameSync(path.join(root, "_gitignore"), path.join(root, ".gitignore"));
|
|
130
|
+
prompts.log.success(`Project created in ${root}`);
|
|
116
131
|
}
|
|
117
|
-
prompts.log.success(`Project created in ${root}`);
|
|
118
|
-
prompts.outro(`Done! Next steps:\n\n cd ${targetDir}\n pnpm install\n pnpm dev`);
|
|
119
132
|
}
|
|
120
133
|
catch (error) {
|
|
121
|
-
prompts.log.error("Failed to
|
|
134
|
+
prompts.log.error("Failed to create project from template");
|
|
135
|
+
console.error(error);
|
|
136
|
+
process.exit(1);
|
|
137
|
+
}
|
|
138
|
+
// Update project name in package.json
|
|
139
|
+
const pkgPath = path.join(root, "package.json");
|
|
140
|
+
if (!fs.existsSync(pkgPath)) {
|
|
141
|
+
prompts.log.error("No package.json found in project");
|
|
142
|
+
process.exit(1);
|
|
143
|
+
}
|
|
144
|
+
try {
|
|
145
|
+
const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
|
|
146
|
+
pkg.name = path.basename(root);
|
|
147
|
+
fs.writeFileSync(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`);
|
|
148
|
+
}
|
|
149
|
+
catch (error) {
|
|
150
|
+
prompts.log.error("Failed to update project name in package.json");
|
|
151
|
+
console.error(error);
|
|
152
|
+
process.exit(1);
|
|
153
|
+
}
|
|
154
|
+
const userAgent = process.env.npm_config_user_agent;
|
|
155
|
+
const pkgManager = userAgent?.split(" ")[0]?.split("/")[0] || "npm";
|
|
156
|
+
// 4. Ask about skills installation
|
|
157
|
+
if (interactive) {
|
|
158
|
+
const skillsResult = await prompts.confirm({
|
|
159
|
+
message: "Install the coding agents skills? (recommended)",
|
|
160
|
+
initialValue: true,
|
|
161
|
+
});
|
|
162
|
+
if (prompts.isCancel(skillsResult)) {
|
|
163
|
+
return cancel();
|
|
164
|
+
}
|
|
165
|
+
if (skillsResult) {
|
|
166
|
+
run([
|
|
167
|
+
...getPkgExecCmd(pkgManager, "skills"),
|
|
168
|
+
"add",
|
|
169
|
+
"alpic-ai/skybridge",
|
|
170
|
+
"-s",
|
|
171
|
+
"chatgpt-app-builder",
|
|
172
|
+
], {
|
|
173
|
+
stdio: "inherit",
|
|
174
|
+
cwd: targetDir,
|
|
175
|
+
});
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
// 5. Ask about immediate installation
|
|
179
|
+
let immediate = argImmediate;
|
|
180
|
+
if (immediate === undefined) {
|
|
181
|
+
if (interactive) {
|
|
182
|
+
const immediateResult = await prompts.confirm({
|
|
183
|
+
message: `Install with ${pkgManager} and start now?`,
|
|
184
|
+
});
|
|
185
|
+
if (prompts.isCancel(immediateResult)) {
|
|
186
|
+
return cancel();
|
|
187
|
+
}
|
|
188
|
+
immediate = immediateResult;
|
|
189
|
+
}
|
|
190
|
+
else {
|
|
191
|
+
immediate = false;
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
const installCmd = [pkgManager, "install"];
|
|
195
|
+
const runCmd = [pkgManager];
|
|
196
|
+
switch (pkgManager) {
|
|
197
|
+
case "yarn":
|
|
198
|
+
case "pnpm":
|
|
199
|
+
case "bun":
|
|
200
|
+
break;
|
|
201
|
+
case "deno":
|
|
202
|
+
runCmd.push("task");
|
|
203
|
+
break;
|
|
204
|
+
default:
|
|
205
|
+
runCmd.push("run");
|
|
206
|
+
}
|
|
207
|
+
runCmd.push("dev");
|
|
208
|
+
if (!immediate) {
|
|
209
|
+
prompts.outro(`Done! Next steps:
|
|
210
|
+
cd ${targetDir}
|
|
211
|
+
${installCmd.join(" ")}
|
|
212
|
+
${runCmd.join(" ")}
|
|
213
|
+
`);
|
|
214
|
+
return;
|
|
215
|
+
}
|
|
216
|
+
prompts.log.step(`Installing dependencies with ${pkgManager}...`);
|
|
217
|
+
run(installCmd, {
|
|
218
|
+
stdio: "inherit",
|
|
219
|
+
cwd: root,
|
|
220
|
+
});
|
|
221
|
+
prompts.log.step("Starting dev server...");
|
|
222
|
+
run(runCmd, {
|
|
223
|
+
stdio: "inherit",
|
|
224
|
+
cwd: root,
|
|
225
|
+
});
|
|
226
|
+
}
|
|
227
|
+
function run([command, ...args], options) {
|
|
228
|
+
const { status, error } = spawnSync(command, args, options);
|
|
229
|
+
if (status != null && status > 0) {
|
|
230
|
+
process.exit(status);
|
|
231
|
+
}
|
|
232
|
+
if (error) {
|
|
233
|
+
console.error(`\n${command} ${args.join(" ")} error!`);
|
|
122
234
|
console.error(error);
|
|
123
235
|
process.exit(1);
|
|
124
236
|
}
|
|
@@ -135,18 +247,37 @@ function sanitizeTargetDir(targetDir) {
|
|
|
135
247
|
// Remove leading/trailing slashes
|
|
136
248
|
.replace(/^\/+|\/+$/g, ""));
|
|
137
249
|
}
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
return
|
|
250
|
+
// Skip user's SPEC.md and IDE/agent preferences (.idea, .claude, etc.)
|
|
251
|
+
function isSkippedEntry(entry) {
|
|
252
|
+
return ((entry.name.startsWith(".") && entry.isDirectory()) ||
|
|
253
|
+
entry.name === "SPEC.md");
|
|
254
|
+
}
|
|
255
|
+
function isEmpty(dirPath) {
|
|
256
|
+
const entries = fs.readdirSync(dirPath, { withFileTypes: true });
|
|
257
|
+
return entries.every(isSkippedEntry);
|
|
141
258
|
}
|
|
142
259
|
function emptyDir(dir) {
|
|
143
260
|
if (!fs.existsSync(dir)) {
|
|
144
261
|
return;
|
|
145
262
|
}
|
|
146
|
-
for (const
|
|
147
|
-
if (
|
|
263
|
+
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
|
264
|
+
if (isSkippedEntry(entry)) {
|
|
148
265
|
continue;
|
|
149
266
|
}
|
|
150
|
-
fs.rmSync(path.
|
|
267
|
+
fs.rmSync(path.join(dir, entry.name), { recursive: true, force: true });
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
function getPkgExecCmd(pkgManager, cmd) {
|
|
271
|
+
switch (pkgManager) {
|
|
272
|
+
case "yarn":
|
|
273
|
+
return ["yarn", "dlx", cmd];
|
|
274
|
+
case "pnpm":
|
|
275
|
+
return ["pnpm", "dlx", cmd];
|
|
276
|
+
case "bun":
|
|
277
|
+
return ["bunx", cmd];
|
|
278
|
+
case "deno":
|
|
279
|
+
return ["deno", "run", "-A", `npm:${cmd}`];
|
|
280
|
+
default:
|
|
281
|
+
return ["npx", cmd];
|
|
151
282
|
}
|
|
152
283
|
}
|
package/dist/index.test.js
CHANGED
|
@@ -14,14 +14,20 @@ describe("create-skybridge", () => {
|
|
|
14
14
|
force: true,
|
|
15
15
|
});
|
|
16
16
|
});
|
|
17
|
-
it("should
|
|
17
|
+
it("should copy the template", async () => {
|
|
18
18
|
const name = `../../${tempDirName}//project$`;
|
|
19
19
|
await init([name]);
|
|
20
20
|
await fs.access(path.join(process.cwd(), tempDirName, "project", ".gitignore"));
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
}
|
|
25
|
-
|
|
21
|
+
expect(fs.access(path.join(process.cwd(), tempDirName, "project", ".npmrc"))).rejects.toThrowError();
|
|
22
|
+
});
|
|
23
|
+
it("should download template from repo", async () => {
|
|
24
|
+
const name = `../../${tempDirName}//project$`;
|
|
25
|
+
await init([
|
|
26
|
+
name,
|
|
27
|
+
"--repo",
|
|
28
|
+
"github:alpic-ai/skybridge/examples/ecom-carousel",
|
|
29
|
+
]);
|
|
30
|
+
await fs.access(path.join(process.cwd(), tempDirName, "project", ".gitignore"));
|
|
31
|
+
expect(fs.access(path.join(process.cwd(), tempDirName, "project", ".npmrc"))).rejects.toThrowError();
|
|
26
32
|
});
|
|
27
33
|
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-skybridge",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.f6bca06",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Alpic",
|
|
@@ -16,21 +16,20 @@
|
|
|
16
16
|
"dist",
|
|
17
17
|
"template"
|
|
18
18
|
],
|
|
19
|
-
"scripts": {
|
|
20
|
-
"build": "tsc",
|
|
21
|
-
"test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
|
|
22
|
-
"test:unit": "vitest run",
|
|
23
|
-
"test:type": "tsc --noEmit",
|
|
24
|
-
"test:format": "biome ci",
|
|
25
|
-
"prepublishOnly": "pnpm run build"
|
|
26
|
-
},
|
|
27
19
|
"dependencies": {
|
|
28
|
-
"@clack/prompts": "^0.
|
|
20
|
+
"@clack/prompts": "^1.0.0",
|
|
21
|
+
"giget": "^3.1.2",
|
|
29
22
|
"mri": "^1.2.0"
|
|
30
23
|
},
|
|
31
24
|
"devDependencies": {
|
|
32
|
-
"@types/node": "^25.0.3",
|
|
33
25
|
"typescript": "^5.9.3",
|
|
34
|
-
"vitest": "^
|
|
26
|
+
"vitest": "^4.0.18"
|
|
27
|
+
},
|
|
28
|
+
"scripts": {
|
|
29
|
+
"build": "tsc",
|
|
30
|
+
"test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
|
|
31
|
+
"test:unit": "vitest run",
|
|
32
|
+
"test:type": "tsc --noEmit",
|
|
33
|
+
"test:format": "biome ci"
|
|
35
34
|
}
|
|
36
|
-
}
|
|
35
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Before writing code, first explore the project structure, then invoke the chatgpt-app-builder skill for documentation.
|
package/template/README.md
CHANGED
|
@@ -1,21 +1,26 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Skybridge Starter
|
|
2
2
|
|
|
3
|
-
A minimal TypeScript template for building
|
|
3
|
+
A minimal TypeScript template for building MCP and ChatGPT Apps with the [Skybridge](https://docs.skybridge.tech/home) framework.
|
|
4
4
|
|
|
5
5
|
## Getting Started
|
|
6
6
|
|
|
7
7
|
### Prerequisites
|
|
8
8
|
|
|
9
|
-
- Node.js
|
|
10
|
-
-
|
|
11
|
-
- HTTP tunnel such as [ngrok](https://ngrok.com/download)
|
|
9
|
+
- Node.js 24+
|
|
10
|
+
- HTTP tunnel such as [ngrok](https://ngrok.com/download) if you want to test with remote MCP hosts like ChatGPT or Claude.ai.
|
|
12
11
|
|
|
13
12
|
### Local Development
|
|
14
13
|
|
|
15
14
|
#### 1. Install
|
|
16
15
|
|
|
17
16
|
```bash
|
|
17
|
+
npm install
|
|
18
|
+
# or
|
|
19
|
+
yarn install
|
|
20
|
+
# or
|
|
18
21
|
pnpm install
|
|
22
|
+
# or
|
|
23
|
+
bun install
|
|
19
24
|
```
|
|
20
25
|
|
|
21
26
|
#### 2. Start your local server
|
|
@@ -23,44 +28,72 @@ pnpm install
|
|
|
23
28
|
Run the development server from the root directory:
|
|
24
29
|
|
|
25
30
|
```bash
|
|
31
|
+
npm run dev
|
|
32
|
+
# or
|
|
33
|
+
yarn dev
|
|
34
|
+
# or
|
|
26
35
|
pnpm dev
|
|
36
|
+
# or
|
|
37
|
+
bun dev
|
|
27
38
|
```
|
|
28
39
|
|
|
29
|
-
This command starts
|
|
40
|
+
This command starts:
|
|
41
|
+
- Your MCP server at `http://localhost:3000/mcp`.
|
|
42
|
+
- Skybridge DevTools UI at `http://localhost:3000/`.
|
|
30
43
|
|
|
31
|
-
|
|
32
|
-
- a React application on Vite HMR dev server (the UI elements to be displayed in ChatGPT)
|
|
44
|
+
#### 3. Project structure
|
|
33
45
|
|
|
34
|
-
#### 3. Connect to ChatGPT
|
|
35
|
-
|
|
36
|
-
- ChatGPT requires connectors to be publicly accessible. To expose your server on the Internet, run:
|
|
37
|
-
```bash
|
|
38
|
-
ngrok http 3000
|
|
39
46
|
```
|
|
40
|
-
|
|
47
|
+
├── server/
|
|
48
|
+
│ └── src/
|
|
49
|
+
│ ├── index.ts # Entry point
|
|
50
|
+
│ ├── middleware.ts # MCP middleware
|
|
51
|
+
│ └── server.ts # Widget registry & routes
|
|
52
|
+
├── web/
|
|
53
|
+
│ ├── src/
|
|
54
|
+
│ │ ├── widgets/ # React components (one per widget)
|
|
55
|
+
│ │ ├── helpers.ts # Shared utilities
|
|
56
|
+
│ │ └── index.css # Global styles
|
|
57
|
+
│ └── vite.config.ts
|
|
58
|
+
├── alpic.json # Deployment config
|
|
59
|
+
├── nodemon.json # Dev server config
|
|
60
|
+
└── package.json
|
|
61
|
+
```
|
|
41
62
|
|
|
42
63
|
### Create your first widget
|
|
43
64
|
|
|
44
65
|
#### 1. Add a new widget
|
|
45
66
|
|
|
46
|
-
- Register a widget in `server/server.ts` with a unique name (e.g., `my-widget`)
|
|
47
|
-
- Create a matching React component at `web/src/widgets/my-widget.tsx`. The file name must match the widget name exactly
|
|
67
|
+
- Register a widget in `server/src/server.ts` with a unique name (e.g., `my-widget`) using [`registerWidget`](https://docs.skybridge.tech/api-reference/register-widget)
|
|
68
|
+
- Create a matching React component at `web/src/widgets/my-widget.tsx`. **The file name must match the widget name exactly**.
|
|
48
69
|
|
|
49
70
|
#### 2. Edit widgets with Hot Module Replacement (HMR)
|
|
50
71
|
|
|
51
|
-
Edit and save components in `web/src/widgets/` — changes appear instantly
|
|
72
|
+
Edit and save components in `web/src/widgets/` — changes will appear instantly inside your App.
|
|
52
73
|
|
|
53
74
|
#### 3. Edit server code
|
|
54
75
|
|
|
55
|
-
Modify files in `server/` and
|
|
76
|
+
Modify files in `server/` and refresh the connection with your testing MCP Client to see the changes.
|
|
77
|
+
|
|
78
|
+
### Testing your App
|
|
79
|
+
|
|
80
|
+
You can test your App locally by using our DevTools UI on `localhost:3000` while running the `pnpm dev` command.
|
|
81
|
+
|
|
82
|
+
To test your app with other MCP Clients like ChatGPT, Claude or VSCode, see [Testing Your App](https://docs.skybridge.tech/quickstart/test-your-app).
|
|
83
|
+
|
|
56
84
|
|
|
57
85
|
## Deploy to Production
|
|
58
86
|
|
|
59
|
-
|
|
60
|
-
- In ChatGPT, navigate to **Settings → Connectors → Create** and add your MCP server URL (e.g., `https://your-app-name.alpic.live`)
|
|
87
|
+
Skybridge is infrastructure vendor agnostic, and your app can be deployed on any cloud platform supporting MCP.
|
|
61
88
|
|
|
62
|
-
|
|
89
|
+
Deploy your app in minutes with [Alpic](https://alpic.ai/).
|
|
90
|
+
1. Create an account on [Alpic platform](https://app.alpic.ai/).
|
|
91
|
+
2. Connect your GitHub repository to automatically deploy at each commit.
|
|
92
|
+
3. Use your remote App URL to connect it to MCP Clients, or use the Alpic Playground to easily test your App.
|
|
63
93
|
|
|
94
|
+
## Resources
|
|
95
|
+
- [Skybridge Documentation](https://docs.skybridge.tech/)
|
|
64
96
|
- [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
|
|
97
|
+
- [MCP Apps Documentation](https://github.com/modelcontextprotocol/ext-apps/tree/main)
|
|
65
98
|
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
|
|
66
99
|
- [Alpic Documentation](https://docs.alpic.ai/)
|
package/template/_gitignore
CHANGED
package/template/alpic.json
CHANGED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.85.0_@opentelemetry+api@1.9.0/node_modules/alpic/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.85.0_@opentelemetry+api@1.9.0/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.85.0_@opentelemetry+api@1.9.0/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.85.0_@opentelemetry+api@1.9.0/node_modules/alpic/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.85.0_@opentelemetry+api@1.9.0/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.85.0_@opentelemetry+api@1.9.0/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../alpic/bin/run.js" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../alpic/bin/run.js" "$@"
|
|
21
|
+
fi
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/nodemon@3.1.11/node_modules/nodemon/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/nodemon@3.1.11/node_modules/nodemon/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/nodemon@3.1.11/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/nodemon@3.1.11/node_modules/nodemon/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/nodemon@3.1.11/node_modules/nodemon/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/nodemon@3.1.11/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../nodemon/bin/nodemon.js" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../nodemon/bin/nodemon.js" "$@"
|
|
21
|
+
fi
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules/skybridge/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules/skybridge/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules/skybridge/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules/skybridge/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../skybridge/bin/run.js" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../skybridge/bin/run.js" "$@"
|
|
21
|
+
fi
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules/skybridge/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules/skybridge/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules/skybridge/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules/skybridge/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.29.1_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@types+node@25.2.2_@types+_7023033a14d97e7a1ad4af54831f1601/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../skybridge/bin/run.js" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../skybridge/bin/run.js" "$@"
|
|
21
|
+
fi
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../typescript/bin/tsc" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../typescript/bin/tsc" "$@"
|
|
21
|
+
fi
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/typescript@5.9.3/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../typescript/bin/tsserver" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../typescript/bin/tsserver" "$@"
|
|
21
|
+
fi
|