create-skybridge 0.0.0-dev.a8c5b9c → 0.0.0-dev.a9633ca
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 +119 -51
- package/dist/index.test.js +11 -1
- package/package.json +12 -13
- package/template/AGENTS.md +1 -0
- package/template/README.md +52 -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/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/package.json +22 -10
- package/template/server/src/index.ts +62 -35
- package/template/tsconfig.json +9 -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 +9 -4
- 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 -32
- package/template/server/src/middleware.ts +0 -54
- package/template/server/src/server.ts +0 -66
- 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
|
@@ -3,8 +3,8 @@ import fs from "node:fs";
|
|
|
3
3
|
import path from "node:path";
|
|
4
4
|
import { fileURLToPath } from "node:url";
|
|
5
5
|
import * as prompts from "@clack/prompts";
|
|
6
|
+
import { downloadTemplate } from "giget";
|
|
6
7
|
import mri from "mri";
|
|
7
|
-
const minimumPnpmVersion = 10;
|
|
8
8
|
const defaultProjectName = "skybridge-project";
|
|
9
9
|
// prettier-ignore
|
|
10
10
|
const helpMessage = `\
|
|
@@ -14,21 +14,30 @@ Create a new Skybridge project by copying the starter template.
|
|
|
14
14
|
|
|
15
15
|
Options:
|
|
16
16
|
-h, --help show this help message
|
|
17
|
+
--repo <uri> use a git repository instead of the built-in template
|
|
17
18
|
--overwrite remove existing files in target directory
|
|
18
19
|
--immediate install dependencies and start development server
|
|
19
20
|
|
|
21
|
+
Repository URI formats:
|
|
22
|
+
github:user/repo
|
|
23
|
+
gitlab:user/repo/subdirectory
|
|
24
|
+
bitbucket:user/repo#branch
|
|
25
|
+
|
|
20
26
|
Examples:
|
|
21
27
|
create-skybridge my-app
|
|
28
|
+
create-skybridge my-app --repo github:alpic-ai/skybridge/examples/ecom-carousel
|
|
22
29
|
create-skybridge . --overwrite --immediate
|
|
23
30
|
`;
|
|
24
31
|
export async function init(args = process.argv.slice(2)) {
|
|
25
32
|
const argv = mri(args, {
|
|
26
|
-
boolean: ["help", "overwrite"],
|
|
33
|
+
boolean: ["help", "overwrite", "immediate"],
|
|
34
|
+
string: ["repo"],
|
|
27
35
|
alias: { h: "help" },
|
|
28
36
|
});
|
|
29
37
|
const argTargetDir = argv._[0]
|
|
30
38
|
? sanitizeTargetDir(String(argv._[0]))
|
|
31
39
|
: undefined;
|
|
40
|
+
const argRepo = argv.repo;
|
|
32
41
|
const argOverwrite = argv.overwrite;
|
|
33
42
|
const argImmediate = argv.immediate;
|
|
34
43
|
const help = argv.help;
|
|
@@ -47,13 +56,14 @@ export async function init(args = process.argv.slice(2)) {
|
|
|
47
56
|
defaultValue: defaultProjectName,
|
|
48
57
|
placeholder: defaultProjectName,
|
|
49
58
|
validate: (value) => {
|
|
50
|
-
return value
|
|
59
|
+
return !value || sanitizeTargetDir(value).length > 0
|
|
51
60
|
? undefined
|
|
52
61
|
: "Invalid project name";
|
|
53
62
|
},
|
|
54
63
|
});
|
|
55
|
-
if (prompts.isCancel(projectName))
|
|
64
|
+
if (prompts.isCancel(projectName)) {
|
|
56
65
|
return cancel();
|
|
66
|
+
}
|
|
57
67
|
targetDir = sanitizeTargetDir(projectName);
|
|
58
68
|
}
|
|
59
69
|
else {
|
|
@@ -81,8 +91,9 @@ export async function init(args = process.argv.slice(2)) {
|
|
|
81
91
|
},
|
|
82
92
|
],
|
|
83
93
|
});
|
|
84
|
-
if (prompts.isCancel(res))
|
|
94
|
+
if (prompts.isCancel(res)) {
|
|
85
95
|
return cancel();
|
|
96
|
+
}
|
|
86
97
|
overwrite = res;
|
|
87
98
|
}
|
|
88
99
|
else {
|
|
@@ -94,43 +105,82 @@ export async function init(args = process.argv.slice(2)) {
|
|
|
94
105
|
emptyDir(targetDir);
|
|
95
106
|
break;
|
|
96
107
|
case "no":
|
|
97
|
-
|
|
98
|
-
|
|
108
|
+
prompts.log.error("Target directory is not empty.");
|
|
109
|
+
process.exit(1);
|
|
99
110
|
}
|
|
100
111
|
}
|
|
101
112
|
const root = path.join(process.cwd(), targetDir);
|
|
102
|
-
// 3.
|
|
103
|
-
prompts.log.step(`Copying template...`);
|
|
113
|
+
// 3. Download from repo or copy template
|
|
104
114
|
try {
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
filter: (src) => !src.endsWith(".npmrc"),
|
|
110
|
-
});
|
|
111
|
-
// Rename _gitignore to .gitignore
|
|
112
|
-
fs.renameSync(path.join(root, "_gitignore"), path.join(root, ".gitignore"));
|
|
113
|
-
// Update project name in package.json
|
|
114
|
-
const name = path.basename(root);
|
|
115
|
-
for (const dir of ["", "server", "web"]) {
|
|
116
|
-
const pkgPath = path.join(root, dir, "package.json");
|
|
117
|
-
const pkg = fs.readFileSync(pkgPath, "utf-8");
|
|
118
|
-
const fixed = pkg.replace(/apps-sdk-template/g, name);
|
|
119
|
-
fs.writeFileSync(pkgPath, fixed);
|
|
115
|
+
if (argRepo) {
|
|
116
|
+
prompts.log.step(`Downloading ${argRepo}...`);
|
|
117
|
+
await downloadTemplate(argRepo, { dir: root });
|
|
118
|
+
prompts.log.success(`Project created in ${root}`);
|
|
120
119
|
}
|
|
121
|
-
|
|
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}`);
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
catch (error) {
|
|
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`);
|
|
122
148
|
}
|
|
123
149
|
catch (error) {
|
|
124
|
-
prompts.log.error("Failed to
|
|
150
|
+
prompts.log.error("Failed to update project name in package.json");
|
|
125
151
|
console.error(error);
|
|
126
152
|
process.exit(1);
|
|
127
153
|
}
|
|
128
|
-
|
|
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
|
|
129
179
|
let immediate = argImmediate;
|
|
130
180
|
if (immediate === undefined) {
|
|
131
181
|
if (interactive) {
|
|
132
182
|
const immediateResult = await prompts.confirm({
|
|
133
|
-
message: `Install with
|
|
183
|
+
message: `Install with ${pkgManager} and start now?`,
|
|
134
184
|
});
|
|
135
185
|
if (prompts.isCancel(immediateResult)) {
|
|
136
186
|
return cancel();
|
|
@@ -141,30 +191,29 @@ export async function init(args = process.argv.slice(2)) {
|
|
|
141
191
|
immediate = false;
|
|
142
192
|
}
|
|
143
193
|
}
|
|
144
|
-
const installCmd = [
|
|
145
|
-
const runCmd = [
|
|
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");
|
|
146
208
|
if (!immediate) {
|
|
147
209
|
prompts.outro(`Done! Next steps:
|
|
148
210
|
cd ${targetDir}
|
|
149
211
|
${installCmd.join(" ")}
|
|
150
212
|
${runCmd.join(" ")}
|
|
151
213
|
`);
|
|
152
|
-
return
|
|
153
|
-
}
|
|
154
|
-
// check if pnpm is installed
|
|
155
|
-
const result = spawnSync("pnpm", ["--version"], { encoding: "utf-8" });
|
|
156
|
-
if (result.error || result.status !== 0) {
|
|
157
|
-
console.error("Error: pnpm is not installed. Please install pnpm first.");
|
|
158
|
-
process.exit(1);
|
|
159
|
-
}
|
|
160
|
-
// check if pnpm major is greater or equal to the one set in package.json packageManager, which should do the trick
|
|
161
|
-
const version = result.stdout.trim();
|
|
162
|
-
const major = Number(version.split(".")[0]);
|
|
163
|
-
if (Number.isNaN(major) || major < minimumPnpmVersion) {
|
|
164
|
-
console.error(`Error: pnpm version ${version} is too old. Minimum required version is ${minimumPnpmVersion}.`);
|
|
165
|
-
process.exit(1);
|
|
214
|
+
return;
|
|
166
215
|
}
|
|
167
|
-
prompts.log.step(`Installing dependencies with
|
|
216
|
+
prompts.log.step(`Installing dependencies with ${pkgManager}...`);
|
|
168
217
|
run(installCmd, {
|
|
169
218
|
stdio: "inherit",
|
|
170
219
|
cwd: root,
|
|
@@ -198,18 +247,37 @@ function sanitizeTargetDir(targetDir) {
|
|
|
198
247
|
// Remove leading/trailing slashes
|
|
199
248
|
.replace(/^\/+|\/+$/g, ""));
|
|
200
249
|
}
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
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);
|
|
204
258
|
}
|
|
205
259
|
function emptyDir(dir) {
|
|
206
260
|
if (!fs.existsSync(dir)) {
|
|
207
261
|
return;
|
|
208
262
|
}
|
|
209
|
-
for (const
|
|
210
|
-
if (
|
|
263
|
+
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
|
264
|
+
if (isSkippedEntry(entry)) {
|
|
211
265
|
continue;
|
|
212
266
|
}
|
|
213
|
-
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];
|
|
214
282
|
}
|
|
215
283
|
}
|
package/dist/index.test.js
CHANGED
|
@@ -14,10 +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
21
|
expect(fs.access(path.join(process.cwd(), tempDirName, "project", ".npmrc"))).rejects.toThrowError();
|
|
22
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();
|
|
32
|
+
});
|
|
23
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.a9633ca",
|
|
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.1",
|
|
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,70 @@ 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 # Server entry point
|
|
50
|
+
├── web/
|
|
51
|
+
│ ├── src/
|
|
52
|
+
│ │ ├── widgets/ # React components (one per widget)
|
|
53
|
+
│ │ ├── helpers.ts # Shared utilities
|
|
54
|
+
│ │ └── index.css # Global styles
|
|
55
|
+
│ └── vite.config.ts
|
|
56
|
+
├── alpic.json # Deployment config
|
|
57
|
+
├── nodemon.json # Dev server config
|
|
58
|
+
└── package.json
|
|
59
|
+
```
|
|
41
60
|
|
|
42
61
|
### Create your first widget
|
|
43
62
|
|
|
44
63
|
#### 1. Add a new widget
|
|
45
64
|
|
|
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
|
|
65
|
+
- 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)
|
|
66
|
+
- Create a matching React component at `web/src/widgets/my-widget.tsx`. **The file name must match the widget name exactly**.
|
|
48
67
|
|
|
49
68
|
#### 2. Edit widgets with Hot Module Replacement (HMR)
|
|
50
69
|
|
|
51
|
-
Edit and save components in `web/src/widgets/` — changes appear instantly
|
|
70
|
+
Edit and save components in `web/src/widgets/` — changes will appear instantly inside your App.
|
|
52
71
|
|
|
53
72
|
#### 3. Edit server code
|
|
54
73
|
|
|
55
|
-
Modify files in `server/` and
|
|
74
|
+
Modify files in `server/` and refresh the connection with your testing MCP Client to see the changes.
|
|
75
|
+
|
|
76
|
+
### Testing your App
|
|
77
|
+
|
|
78
|
+
You can test your App locally by using our DevTools UI on `localhost:3000` while running the `pnpm dev` command.
|
|
79
|
+
|
|
80
|
+
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).
|
|
81
|
+
|
|
56
82
|
|
|
57
83
|
## Deploy to Production
|
|
58
84
|
|
|
59
|
-
|
|
60
|
-
- In ChatGPT, navigate to **Settings → Connectors → Create** and add your MCP server URL (e.g., `https://your-app-name.alpic.live`)
|
|
85
|
+
Skybridge is infrastructure vendor agnostic, and your app can be deployed on any cloud platform supporting MCP.
|
|
61
86
|
|
|
62
|
-
|
|
87
|
+
The simplest way to deploy your App in minutes is [Alpic](https://alpic.ai/).
|
|
88
|
+
1. Create an account on [Alpic platform](https://app.alpic.ai/).
|
|
89
|
+
2. Connect your GitHub repository to automatically deploy at each commit.
|
|
90
|
+
3. Use your remote App URL to connect it to MCP Clients, or use the Alpic Playground to easily test your App.
|
|
63
91
|
|
|
92
|
+
## Resources
|
|
93
|
+
- [Skybridge Documentation](https://docs.skybridge.tech/)
|
|
64
94
|
- [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
|
|
95
|
+
- [MCP Apps Documentation](https://github.com/modelcontextprotocol/ext-apps/tree/main)
|
|
65
96
|
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
|
|
66
97
|
- [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.90.0_@opentelemetry+api@1.9.0/node_modules/alpic/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.90.0_@opentelemetry+api@1.9.0/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.90.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.90.0_@opentelemetry+api@1.9.0/node_modules/alpic/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.90.0_@opentelemetry+api@1.9.0/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.90.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/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/node_modules/skybridge/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/node_modules/skybridge/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/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.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/node_modules/skybridge/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/node_modules/skybridge/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/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.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/node_modules/skybridge/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/node_modules/skybridge/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/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.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/node_modules/skybridge/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/node_modules/skybridge/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/skybridge@0.32.0_@modelcontextprotocol+sdk@1.26.0_zod@4.3.6__@skybridge+devtools@0.32.0_48f68782a2196cef65114164dd9a2fc2/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
|
|
@@ -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/tsx@4.21.0/node_modules/tsx/dist/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/tsx@4.21.0/node_modules/tsx/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/tsx@4.21.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/tsx@4.21.0/node_modules/tsx/dist/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/tsx@4.21.0/node_modules/tsx/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/tsx@4.21.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/../tsx/dist/cli.mjs" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../tsx/dist/cli.mjs" "$@"
|
|
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/vite@7.3.1_@types+node@25.2.3_jiti@2.6.1_lightningcss@1.31.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/node_modules/vite/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/vite@7.3.1_@types+node@25.2.3_jiti@2.6.1_lightningcss@1.31.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/node_modules/vite/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/vite@7.3.1_@types+node@25.2.3_jiti@2.6.1_lightningcss@1.31.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/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/vite@7.3.1_@types+node@25.2.3_jiti@2.6.1_lightningcss@1.31.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/node_modules/vite/bin/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/vite@7.3.1_@types+node@25.2.3_jiti@2.6.1_lightningcss@1.31.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/node_modules/vite/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/vite@7.3.1_@types+node@25.2.3_jiti@2.6.1_lightningcss@1.31.1_terser@5.44.1_tsx@4.21.0_yaml@2.8.2/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/../vite/bin/vite.js" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../vite/bin/vite.js" "$@"
|
|
21
|
+
fi
|