Skip to content

Commit

Permalink
chore: rename, more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jankaszel committed May 3, 2020
1 parent 0d8557c commit 91bc355
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 15 deletions.
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
# Test Environment for Hyperwell
# Annotation Environment for Hyperwell

You will need to have [Node.js](https://nodejs.org) installed.
This application serves as an experimental annotation environment for testing real-time, collaborative annotation with the [Hyperwell gateway](https://github.com/hyperwell/gateway).

## Get started

Install the dependencies...

```bash
npm install
```

... then start [Rollup](https://rollupjs.org):

```bash
npm run dev
```
You will need to have [Node.js](https://nodejs.org) installed. Install the dependencies via `npm install` and start the [Rollup development server](https://rollupjs.org) via `npm run dev`.

Navigate to [localhost:5000](http://localhost:5000). You should see your app running. To test the annotation environment with a notebook provided by a Hyperwell gateway, obtain its gateway-issued URL (which is based on its ID, e.g., `http://gateway.example.com/annotatios/abcdef123`). Enter the full URL and make sure to check the Hyperwell option. By clicking the ‘Load Annotations’ button, the environment will fetch all existing annotations and establish a WebSocket connection for receiving real-time updates by collaborators.

Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{
"name": "hyperwell-test-environment",
"version": "1.0.0",
"name": "@hyperwell/annotation-environment",
"version": "0.1.0",
"private": true,
"author": "Jan Kaßel <[email protected]>",
"scripts": {
"build": "rollup -c",
"dev": "rollup -c -w",
Expand Down

0 comments on commit 91bc355

Please sign in to comment.