56 lines
1.7 KiB
Markdown
56 lines
1.7 KiB
Markdown
<div align="center">
|
|
<a href="https://hoppscotch.io">
|
|
<img height=64 src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/main/static/logo.png" alt="The Hoppscotch UFO logo" />
|
|
</a>
|
|
</div>
|
|
<div align="center">
|
|
|
|
# Hoppscotch JavaScript Sandbox <font size=2><sup>ALPHA</sup></font>
|
|
|
|
</div>
|
|
|
|
This package deals with providing a JavaScript sandbox for executing various security sensitive external scripts.
|
|
|
|
## Usage
|
|
- Install the [npm package](https://www.npmjs.com/package/@hoppscotch/js-sandbox)
|
|
```
|
|
npm install --save @hoppscotch/js-sandbox
|
|
```
|
|
|
|
## How does this work ?
|
|
This package makes use of [quickjs-empscripten](https://www.npmjs.com/package/quickjs-emscripten) for building sandboxes for running external code on Hoppscotch.
|
|
|
|
Currently implemented sandboxes:
|
|
- Hoppscotch Test Scripts
|
|
|
|
## Development
|
|
- Clone the repository
|
|
```
|
|
git clone https://github.com/hoppscotch/hopp-js-sandbox
|
|
```
|
|
|
|
- Install the package deps
|
|
```
|
|
npm install
|
|
```
|
|
|
|
- Try out the demo [`src/demo.ts`](https://github.com/hoppscotch/hopp-js-sandbox/blob/main/src/demo.ts) using
|
|
```
|
|
npm run demo
|
|
```
|
|
|
|
## Versioning
|
|
This project follows [Semantic Versioning](https://semver.org/) but as the project is still pre-1.0. The code and the public exposed API should not be considered to be fixed and stable. Things can change at any time!
|
|
|
|
## License
|
|
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see [`LICENSE`](https://github.com/hoppscotch/hopp-js-sandbox/blob/main/LICENSE) for more details.
|
|
|
|
<div align="center">
|
|
<br />
|
|
<br />
|
|
<br />
|
|
|
|
|
|
###### built with ❤︎ by the [Hoppscotch Team](https://github.com/hoppscotch) and [contributors](https://github.com/AndrewBastin/hopp-js-sandbox/graphs/contributors).
|
|
|
|
</div> |