https://github.com/stackblitz/sdk
https://github.com/stackblitz/sdk
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stackblitz/sdk
- Owner: stackblitz
- License: mit
- Created: 2022-11-08T17:09:50.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T09:43:45.000Z (over 1 year ago)
- Last Synced: 2025-02-25T11:07:42.075Z (11 months ago)
- Language: TypeScript
- Size: 115 KB
- Stars: 30
- Watchers: 8
- Forks: 20
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# StackBlitz SDK
The StackBlitz JavaScript SDK lets you programmatically create StackBlitz projects to be opened in a new window or embedded in your docs, example pages, or blog posts.
## Documentation
Check out our SDK documentation on developer.stackblitz.com:
- [SDK overview](https://developer.stackblitz.com/platform/api/javascript-sdk)
- [Options reference](https://developer.stackblitz.com/platform/api/javascript-sdk-options)
- [Controlling embeds](https://developer.stackblitz.com/platform/api/javascript-sdk-vm)
## Reporting issues
- Issues with the SDK can be filed at https://github.com/stackblitz/sdk/issues
- Other issues with StackBlitz can be filed at https://github.com/stackblitz/core/issues
## Development
We use `npm` and Node 16+.
```sh
# Install dependencies
npm install
# Start a development server to explore examples
npm start
# Run unit tests
npm test
# Run end-to-end tests with mock server
npm run test:e2e
# Run end-to-end tests against stackblitz.com
STACKBLITZ_SERVER_ORIGIN=https://stackblitz.com npm run test:e2e
# Generate the 'bundles' and 'types' folders
npm run build
```