Skip to content

Commit

Permalink
Rename browser package to webui (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
carbonrobot authored Sep 20, 2023
1 parent a572974 commit 6f5a479
Show file tree
Hide file tree
Showing 62 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,34 @@

## Getting Started

### 1. Install the Envy Browser to view application telemetry in your browser
### 1. Install the Envy Web UI to view application telemetry in your browser

```sh
# npm
$ npm i --save-dev @envy/browser
$ npm i --save-dev @envy/webui
# or yarn
$ yarn add --dev @envy/browser
$ yarn add --dev @envy/webui
```

### 2. Install a telemetry package for your application

- [Node.js Application](#nodejs-application)
- [Web Client Application](#web-client-application)

### 3. Run the browser and start collecting telemetry
### 3. Run the Web UI and start collecting telemetry

Run the browser in a seperate terminal session

```
npx @envy/browser
npx @envy/webui
```

or optionally, add it to your NPM scripts using a tool like [concurrently](https://www.npmjs.com/package/concurrently)

```json
"scripts": {
"start": "<your application start command>",
"start:withenvy": "concurrently \"npx @envy/browser\" \"npm start\""
"start:withenvy": "concurrently \"npx @envy/webui\" \"npm start\""
},
```

Expand Down
2 changes: 1 addition & 1 deletion examples/apollo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"dependencies": {
"@apollo/server": "^4.9.3",
"@envy/browser": "*",
"@envy/webui": "*",
"@envy/node": "*",
"@sanity/client": "^4.0.1",
"apollo-utilities": "^1.3.4",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ module.exports = {
},
'import/resolver': {
typescript: {
project: 'packages/browser/tsconfig.json',
project: 'packages/webui/tsconfig.json',
},
alias: [['@', path.resolve(__dirname, './src')]],
},
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @envy/browser
# @envy/webui

## 0.1.1

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions packages/browser/package.json → packages/webui/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@envy/browser",
"name": "@envy/webui",
"version": "0.1.1",
"description": "Envy Web UI",
"source": [
Expand Down Expand Up @@ -66,7 +66,7 @@
],
"staticFiles": {
"staticPath": [
"packages/browser/static"
"packages/webui/static"
]
}
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 6f5a479

Please sign in to comment.