You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,12 +53,15 @@ sunpeak is an npm package consisting of:
53
53
1. Runtime APIs - Strongly typed, multi-platform APIs for interacting with the ChatGPT runtime, architected to support future platforms (Gemini, Claude).
3. MCP server - Mock data MCP server for testing local Resources in the real ChatGPT.
56
-
2.**The `sunpeak` framework** (`./template`). An end-to-end framework for ChatGPT Apps, from quickstart to shipped. This templated npm package includes:
57
-
1. Project scaffold - Complete development setup with build, test, and mcp tooling.
56
+
2.**The `sunpeak` framework** (`./template`). Next.js for ChatGPT Apps. This templated npm package includes:
57
+
1. Project scaffold - Complete development setup with build, test, and mcp tooling, including the sunpeak library.
58
58
2. UI components - Production-ready components following ChatGPT design guidelines and using OpenAI apps-sdk-ui React components.
59
-
3. CLI utility (`./bin`) - Commands for working with the sunpeak framework.
59
+
3.**The `sunpeak` CLI** (`./bin`). Commands for managing ChatGPT Apps. Includes a client for the sunpeak Resource Repository (ECR for ChatGPT Apps). The repository helps you & your CI/CD decouple your App from your client-agnostic MCP server:
60
+
1. Tag your app builds with version numbers and environment names (like `v1.0.0` and `prod`)
61
+
2.`push` built Apps to a central location
62
+
3.`pull` built Apps to be run in different environments
60
63
61
-
Note that the`sunpeak`library can be used without the framework.
64
+
Note that each`sunpeak`component can be used in isolation if preferred, though the most seamless experience combines all 3.
62
65
63
66
## Example Component
64
67
@@ -81,12 +84,6 @@ export function MCPResource() {
81
84
}
82
85
```
83
86
84
-
## Contributing
85
-
86
-
We welcome your contributions!
87
-
88
-
For development quickstart on this package, see [DEVELOPMENT.md](./DEVELOPMENT.md).
0 commit comments