btwedutech/hoppscotch
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

chore(docs): updated readme

Browse Source
This commit is contained in:
liyasthomas
2021-09-25 12:21:19 +05:30
parent 9454d8c100
commit 0c389701fe
2 changed files with 27 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -302,9 +302,10 @@ _Sample keys only works with the [production build](https://hoppscotch.io)._
### Local development environment
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
2. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`).
3. Start the development server with `pnpm run dev`.
4. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser.
2. Install pnpm using npm by running `npm install -g pnpm`.
3. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`).
4. Start the development server with `pnpm run dev`.
5. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser.
### Docker compose
@@ -323,9 +324,10 @@ docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest
## **Releasing**
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
2. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`).
3. Build the release files with `pnpm run generate`.
4. Find the built project in `packages/hoppscotch-app/dist`.
2. Install pnpm using npm by running `npm install -g pnpm`.
3. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`).
4. Build the release files with `pnpm run generate`.
5. Find the built project in `packages/hoppscotch-app/dist`.
## **Contributing**

29
packages/hoppscotch-js-sandbox/README.md
View File

@@ -1,6 +1,10 @@
<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" />
<img
src="https://avatars.githubusercontent.com/u/56705483"
alt="Hoppscotch Logo"
height="64"
/>
</a>
</div>
<div align="center">
@@ -12,29 +16,36 @@
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)
Install the [npm package](https://www.npmjs.com/package/@hoppscotch/js-sandbox).
```
npm install --save @hoppscotch/js-sandbox
```
## How does this work ?
## 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
1. Clone the repository
```
git clone https://github.com/hoppscotch/hopp-js-sandbox
```
- Install the package deps
2. Install the package dependencies
```
npm install
```
- Try out the demo [`src/demo.ts`](https://github.com/hoppscotch/hopp-js-sandbox/blob/main/src/demo.ts) using
3. Try out the demo [`src/demo.ts`](https://github.com/hoppscotch/hopp-js-sandbox/blob/main/src/demo.ts) using:
```
npm run demo
```
@@ -48,9 +59,7 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
<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>
</div>