create-skybridge 0.0.0-dev.ecf87cf → 0.0.0-dev.fd05cd0

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.
Files changed (35) hide show
  1. package/dist/index.js +17 -28
  2. package/package.json +3 -2
  3. package/template/.cursor/mcp.json +7 -0
  4. package/template/.nvmrc +1 -0
  5. package/template/.vscode/launch.json +16 -0
  6. package/template/.vscode/settings.json +3 -0
  7. package/template/.vscode/tasks.json +14 -0
  8. package/template/README.md +116 -0
  9. package/template/_gitignore +194 -0
  10. package/template/alpic.json +4 -0
  11. package/template/docs/demo.gif +0 -0
  12. package/template/package.json +21 -0
  13. package/template/pnpm-lock.yaml +317 -0
  14. package/template/pnpm-workspace.yaml +7 -0
  15. package/template/server/nodemon.json +5 -0
  16. package/template/server/package.json +36 -0
  17. package/template/server/pnpm-lock.yaml +3796 -0
  18. package/template/server/src/env.ts +12 -0
  19. package/template/server/src/index.ts +34 -0
  20. package/template/server/src/middleware.ts +54 -0
  21. package/template/server/src/pokedex.ts +148 -0
  22. package/template/server/src/server.ts +76 -0
  23. package/template/server/tsconfig.json +17 -0
  24. package/template/web/components.json +22 -0
  25. package/template/web/package.json +32 -0
  26. package/template/web/pnpm-lock.yaml +2629 -0
  27. package/template/web/src/components/ui/shadcn-io/spinner/index.tsx +272 -0
  28. package/template/web/src/helpers.ts +4 -0
  29. package/template/web/src/index.css +120 -0
  30. package/template/web/src/utils.ts +6 -0
  31. package/template/web/src/widgets/pokemon.tsx +203 -0
  32. package/template/web/tsconfig.app.json +34 -0
  33. package/template/web/tsconfig.json +13 -0
  34. package/template/web/tsconfig.node.json +26 -0
  35. package/template/web/vite.config.ts +16 -0
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
- import { spawnSync } from "node:child_process";
2
1
  import fs from "node:fs";
3
2
  import path from "node:path";
3
+ import { fileURLToPath } from "node:url";
4
4
  import * as prompts from "@clack/prompts";
5
5
  import mri from "mri";
6
6
  const argv = mri(process.argv.slice(2), {
@@ -8,13 +8,12 @@ const argv = mri(process.argv.slice(2), {
8
8
  alias: { h: "help" },
9
9
  });
10
10
  const cwd = process.cwd();
11
- const TEMPLATE_REPO = "https://github.com/alpic-ai/apps-sdk-template";
12
11
  const defaultProjectName = "skybridge-project";
13
12
  // prettier-ignore
14
13
  const helpMessage = `\
15
14
  Usage: create-skybridge [OPTION]... [DIRECTORY]
16
15
 
17
- Create a new Skybridge project by cloning the starter template.
16
+ Create a new Skybridge project by copying the starter template.
18
17
 
19
18
  Options:
20
19
  -h, --help show this help message
@@ -24,20 +23,6 @@ Examples:
24
23
  create-skybridge my-app
25
24
  create-skybridge . --overwrite
26
25
  `;
27
- function run([command, ...args], options) {
28
- if (!command) {
29
- throw new Error("Command is required");
30
- }
31
- const { status, error } = spawnSync(command, args, options);
32
- if (status != null && status > 0) {
33
- process.exit(status);
34
- }
35
- if (error) {
36
- console.error(`\n${command} ${args.join(" ")} error!`);
37
- console.error(error);
38
- process.exit(1);
39
- }
40
- }
41
26
  async function init() {
42
27
  const argTargetDir = argv._[0]
43
28
  ? formatTargetDir(String(argv._[0]))
@@ -111,23 +96,27 @@ async function init() {
111
96
  }
112
97
  }
113
98
  const root = path.join(cwd, targetDir);
114
- // 3. Clone the repository
115
- prompts.log.step(`Cloning template from ${TEMPLATE_REPO}...`);
99
+ // 3. Copy the repository
100
+ prompts.log.step(`Copying template...`);
116
101
  try {
117
- // Clone directly to target directory
118
- run(["git", "clone", "--depth", "1", TEMPLATE_REPO, root], {
119
- stdio: "inherit",
120
- });
121
- // Remove .git directory to start fresh
122
- const gitDir = path.join(root, ".git");
123
- if (fs.existsSync(gitDir)) {
124
- fs.rmSync(gitDir, { recursive: true, force: true });
102
+ const templateDir = fileURLToPath(new URL("../template", import.meta.url));
103
+ // Copy template to target directory
104
+ fs.cpSync(templateDir, root, { recursive: true });
105
+ // Rename _gitignore to .gitignore
106
+ fs.renameSync(path.join(root, "_gitignore"), path.join(root, ".gitignore"));
107
+ // Update project name in package.json
108
+ const name = path.basename(root);
109
+ for (const dir of ["", "server", "web"]) {
110
+ const pkgPath = path.join(root, dir, "package.json");
111
+ const pkg = fs.readFileSync(pkgPath, "utf-8");
112
+ const fixed = pkg.replace(/apps-sdk-template/g, name);
113
+ fs.writeFileSync(pkgPath, fixed);
125
114
  }
126
115
  prompts.log.success(`Project created in ${root}`);
127
116
  prompts.outro(`Done! Next steps:\n\n cd ${targetDir}\n pnpm install\n pnpm dev`);
128
117
  }
129
118
  catch (error) {
130
- prompts.log.error("Failed to clone repository");
119
+ prompts.log.error("Failed to copy repository");
131
120
  console.error(error);
132
121
  process.exit(1);
133
122
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-skybridge",
3
- "version": "0.0.0-dev.ecf87cf",
3
+ "version": "0.0.0-dev.fd05cd0",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "author": "Alpic",
@@ -13,7 +13,8 @@
13
13
  },
14
14
  "files": [
15
15
  "index.js",
16
- "dist"
16
+ "dist",
17
+ "template"
17
18
  ],
18
19
  "scripts": {
19
20
  "build": "tsc",
@@ -0,0 +1,7 @@
1
+ {
2
+ "mcpServers": {
3
+ "local": {
4
+ "url": "http://localhost:3000/mcp"
5
+ }
6
+ }
7
+ }
@@ -0,0 +1 @@
1
+ lts/jod
@@ -0,0 +1,16 @@
1
+ {
2
+ "version": "0.0.1",
3
+ "configurations": [
4
+ {
5
+ "name": "Debug MCP Server",
6
+ "type": "node",
7
+ "request": "launch",
8
+ "program": "${workspaceFolder}/dist/index.js",
9
+ "console": "integratedTerminal",
10
+ "sourceMaps": true,
11
+ "outFiles": ["${workspaceFolder}/dist/**/*.js"],
12
+ "preLaunchTask": "npm: build",
13
+ "stopOnEntry": false
14
+ }
15
+ ]
16
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "editor.formatOnSave": true
3
+ }
@@ -0,0 +1,14 @@
1
+ {
2
+ "version": "2.0.0",
3
+ "tasks": [
4
+ {
5
+ "type": "shell",
6
+ "command": "npm",
7
+ "args": ["build"],
8
+ "group": "build",
9
+ "label": "npm: build",
10
+ "detail": "npm build",
11
+ "problemMatcher": ["$tsc"]
12
+ }
13
+ ]
14
+ }
@@ -0,0 +1,116 @@
1
+ # ChatGPT Apps SDK Alpic Starter
2
+
3
+ This repository is a minimal Typescript application demonstrating how to build an OpenAI Apps SDK compatible MCP server with widget rendering in ChatGPT.
4
+
5
+ ![Demo](docs/demo.gif)
6
+
7
+ ## Overview
8
+
9
+ This project shows how to integrate a Typescript express application with the ChatGPT Apps SDK using the Model Context Protocol (MCP). It includes a working MCP server that exposes tools and resources that can be called from ChatGPT, with responses rendered natively in ChatGPT. It also includes MCP tools without UI widgets.
10
+
11
+ ## Getting Started
12
+
13
+ ### Prerequisites
14
+
15
+ - Node.js 22+ (see `.nvmrc` for exact version)
16
+ - pnpm (install with `npm install -g pnpm`)
17
+ - Ngrok
18
+
19
+ ### Local Development with Hot Module Replacement (HMR)
20
+
21
+ This project uses Vite for React widget development with full HMR support, allowing you to see changes in real-time, directly within ChatGPT conversation, without restarting the server.
22
+
23
+ #### 1. Install
24
+
25
+ ```bash
26
+ pnpm install
27
+ ```
28
+
29
+ #### 2. Start the Development Server
30
+
31
+ Run the development server from the root directory:
32
+
33
+ ```bash
34
+ pnpm dev
35
+ ```
36
+
37
+ This command starts an Express server on port 3000. This server packages:
38
+
39
+ - an MCP endpoint on `/mcp` - aka the ChatGPT App Backend
40
+ - a React application on Vite HMR dev server - aka the ChatGPT App Frontend
41
+
42
+ #### 3. Expose Your Local Server
43
+
44
+ In a separate terminal, expose your local server using ngrok:
45
+
46
+ ```bash
47
+ ngrok http 3000
48
+ ```
49
+
50
+ Copy the forwarding URL from ngrok output:
51
+
52
+ ```bash
53
+ Forwarding https://3785c5ddc4b6.ngrok-free.app -> http://localhost:3000
54
+ ```
55
+
56
+ #### 4. Connect to ChatGPT
57
+
58
+ - Enable **Settings → Connectors → Advanced → Developer mode** in the ChatGPT client
59
+ - Navigate to **Settings → Connectors → Create**
60
+ - Enter your ngrok URL with the `/mcp` path (e.g., `https://3785c5ddc4b6.ngrok-free.app/mcp`)
61
+ - Click **Create**
62
+
63
+ #### 5. Test Your Integration
64
+
65
+ - Start a new conversation in ChatGPT
66
+ - Select your newly created connector using **the + button → Your connector**
67
+ - Try prompting the model (e.g., "Show me pikachu details")
68
+
69
+ #### 6. Develop with HMR
70
+
71
+ Now you can edit React components in `web` and see changes instantly:
72
+
73
+ - Make changes to any component
74
+ - Save the file
75
+ - The widget will automatically update in ChatGPT without refreshing or reconnecting
76
+ - The Express server and MCP server continue running without interruption
77
+
78
+ **Note:** When you modify widget components, changes will be reflected immediately. If you modify MCP server code (in `src/`), you may need to reload your connector in **Settings → Connectors → [Your connector] → Reload**.
79
+
80
+ ## Widget Naming Convention
81
+
82
+ **Important:** For a widget to work properly, the name of the endpoint in your MCP server must match the file name of the corresponding React component in `web/src/widgets/`.
83
+
84
+ For example:
85
+
86
+ - If you create a widget endpoint named `pokemon-card`, you must create a corresponding React component file at `web/src/widgets/pokemon-card.tsx`
87
+ - The endpoint name and the widget file name (without the `.tsx` extension) must be identical
88
+
89
+ This naming convention allows the system to automatically map widget requests to their corresponding React components.
90
+
91
+ ## Deploy to Production
92
+
93
+ Use Alpic to deploy your OpenAI App to production.
94
+
95
+ [![Deploy on Alpic](https://assets.alpic.ai/button.svg)](https://app.alpic.ai/new/clone?repositoryUrl=https%3A%2F%2Fgithub.com%2Falpic-ai%2Fapps-sdk-template)
96
+
97
+ - In ChatGPT, navigate to **Settings → Connectors → Create** and add your MCP server URL (e.g., `https://your-app-name.alpic.live`)
98
+
99
+ ## Project Structure
100
+
101
+ ```
102
+ .
103
+ ├── server/
104
+ │ ├── app.ts # OpenAI App extension class with widget API implementation
105
+ │ ├── server.ts # MCP server with tool/resource/prompt registration
106
+ │ └── index.ts # Express server definition
107
+ └── web/
108
+ └── src/
109
+ └── widgets/ # React widget components (must match endpoint names)
110
+ ```
111
+
112
+ ## Resources
113
+
114
+ - [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
115
+ - [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
116
+ - [Alpic Documentation](https://docs.alpic.ai/)
@@ -0,0 +1,194 @@
1
+ # =============================================================================
2
+ # OPERATING SYSTEM FILES
3
+ # =============================================================================
4
+ .DS_Store
5
+ .DS_Store?
6
+ ._*
7
+ .Spotlight-V100
8
+ .Trashes
9
+ ehthumbs.db
10
+ Thumbs.db
11
+
12
+ # =============================================================================
13
+ # NODE.JS & PACKAGE MANAGERS
14
+ # =============================================================================
15
+ node_modules/
16
+ npm-debug.log*
17
+ yarn-debug.log*
18
+ yarn-error.log*
19
+ .pnpm-debug.log*
20
+ .npm
21
+ .pnp.js
22
+ .pnp.cjs
23
+ .pnp.mjs
24
+ .pnp.json
25
+ .pnp.ts
26
+
27
+ # =============================================================================
28
+ # TYPESCRIPT & JAVASCRIPT
29
+ # =============================================================================
30
+ *.tsbuildinfo
31
+ .tscache/
32
+ *.js.map
33
+ *.mjs.map
34
+ *.cjs.map
35
+ *.d.ts.map
36
+ *.d.ts
37
+ !*.d.ts.template
38
+ *.tgz
39
+ .eslintcache
40
+ .rollup.cache
41
+
42
+ # =============================================================================
43
+ # PYTHON
44
+ # =============================================================================
45
+ __pycache__/
46
+ *.py[cod]
47
+ *$py.class
48
+ *.so
49
+ .Python
50
+ develop-eggs/
51
+ eggs/
52
+ .eggs/
53
+ lib/
54
+ lib64/
55
+ parts/
56
+ sdist/
57
+ var/
58
+ wheels/
59
+ *.egg-info/
60
+ .installed.cfg
61
+ *.egg
62
+ .pytest_cache/
63
+ .coverage
64
+ htmlcov/
65
+ .tox/
66
+ .venv
67
+ venv/
68
+ ENV/
69
+
70
+ # =============================================================================
71
+ # JAVA
72
+ # =============================================================================
73
+ *.class
74
+ *.jar
75
+ *.war
76
+ *.nar
77
+ *.ear
78
+ hs_err_pid*
79
+ target/
80
+ .gradle/
81
+
82
+ # =============================================================================
83
+ # RUBY
84
+ # =============================================================================
85
+ *.gem
86
+ *.rbc
87
+ /.config
88
+ /coverage/
89
+ /InstalledFiles
90
+ /pkg/
91
+ /spec/reports/
92
+ /spec/examples.txt
93
+ /test/tmp/
94
+ /test/version_tmp/
95
+ /tmp/
96
+ .byebug_history
97
+
98
+ # =============================================================================
99
+ # BUILD & DISTRIBUTION
100
+ # =============================================================================
101
+ build/
102
+ dist/
103
+ dist-ssr/
104
+ out/
105
+
106
+ # =============================================================================
107
+ # COMPILED FILES
108
+ # =============================================================================
109
+ *.com
110
+ *.dll
111
+ *.exe
112
+ *.o
113
+
114
+ # =============================================================================
115
+ # PACKAGE & ARCHIVE FILES
116
+ # =============================================================================
117
+ *.7z
118
+ *.dmg
119
+ *.gz
120
+ *.iso
121
+ *.rar
122
+ *.tar
123
+ *.tar.gz
124
+ *.zip
125
+
126
+ # =============================================================================
127
+ # LOGS & DATABASES
128
+ # =============================================================================
129
+ *.log
130
+ *.sql
131
+ *.sqlite
132
+ *.sqlite3
133
+ logs/
134
+
135
+ # =============================================================================
136
+ # TESTING & COVERAGE
137
+ # =============================================================================
138
+ coverage/
139
+ .nyc_output/
140
+
141
+ # =============================================================================
142
+ # CACHE & TEMPORARY FILES
143
+ # =============================================================================
144
+ .cache/
145
+ .parcel-cache/
146
+ *.bak
147
+
148
+ # =============================================================================
149
+ # ENVIRONMENT & CONFIGURATION
150
+ # =============================================================================
151
+ .env
152
+ .env.local
153
+ .env.development.local
154
+ .env.test.local
155
+ .env.production.local
156
+ .sample-env
157
+ sample.*
158
+ !sample.template.*
159
+ *.local
160
+ mcp-servers.json
161
+ mcp-config.json
162
+
163
+ # =============================================================================
164
+ # DEMO & EXAMPLE DIRECTORIES
165
+ # =============================================================================
166
+ demo/
167
+ demos/
168
+ example/
169
+ examples/
170
+ samples/
171
+
172
+ # =============================================================================
173
+ # GENERATED DOCUMENTATION
174
+ # =============================================================================
175
+ docs/api/
176
+
177
+ # =============================================================================
178
+ # EDITOR DIRECTORIES AND FILES
179
+ # =============================================================================
180
+ .vscode/*
181
+ !.vscode/extensions.json
182
+ .idea
183
+ *.suo
184
+ *.ntvs*
185
+ *.njsproj
186
+ *.sln
187
+ *.sw?
188
+
189
+ # =============================================================================
190
+ # APPLICATION SPECIFIC
191
+ # =============================================================================
192
+ repomix-output*
193
+ duckdata/
194
+ .claude
@@ -0,0 +1,4 @@
1
+ {
2
+ "$schema": "https://assets.alpic.ai/alpic.json",
3
+ "buildOutputDir": "server/dist"
4
+ }
Binary file
@@ -0,0 +1,21 @@
1
+ {
2
+ "name": "apps-sdk-template",
3
+ "version": "0.0.1",
4
+ "private": true,
5
+ "description": "Alpic MCP Server Template",
6
+ "type": "module",
7
+ "packageManager": "pnpm@10.18.3",
8
+ "scripts": {
9
+ "dev": "pnpm --filter @apps-sdk-template/server dev",
10
+ "build": "pnpm web:build && rm -rf server/dist && pnpm --filter=@apps-sdk-template/server --prod deploy server/dist && cp -r web/dist server/dist/assets && pnpm --filter=@apps-sdk-template/server build",
11
+ "start": "pnpm server:start",
12
+ "inspector": "pnpm --filter @apps-sdk-template/server inspector",
13
+ "server:build": "pnpm --filter @apps-sdk-template/server build",
14
+ "server:start": "pnpm --filter @apps-sdk-template/server start",
15
+ "web:build": "pnpm --filter @apps-sdk-template/web build",
16
+ "web:preview": "pnpm --filter @apps-sdk-template/web preview"
17
+ },
18
+ "devDependencies": {
19
+ "tsx": "^4.19.4"
20
+ }
21
+ }