Skip to content

Commit

Permalink
Merge pull request #1435 from ably/remove-react-hooks-license
Browse files Browse the repository at this point in the history
Cleanup react-hooks dir
  • Loading branch information
owenpearson authored Sep 4, 2023
2 parents 9c90fe5 + f4c2119 commit 76a5475
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 54 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,23 @@ When using the test webserver `npm run test:webserver` the following test variab
- `tls_port` - TLS port to use for the tests, defaults to 443
- `tls` - true or false to enable/disable use of TLS respectively
- `log_level` - Log level for the client libraries, defaults to 2, 4 is `MICRO`

## React hooks

The react sample application is configured to execute using Vite - which will load a sample web app that acts as a simple test harness for the hooks.

You can run the dev server from the terminal using:

```bash
npm run start:react
```

You'll need to provide an API key for the sample to work (or you'll just get a white page and some errors in the console). To do this, create the file `./src/platform/react-hooks/sample-app/.env` and add the following line:

```.env
VITE_ABLY_API_KEY=<your-api-key>
```

This API key will be loaded by the vite dev server at build time.

You can run the unit tests by running `npm run test:react` in the terminal.
33 changes: 0 additions & 33 deletions src/platform/react-hooks/CONTRIBUTING.md

This file was deleted.

21 changes: 0 additions & 21 deletions src/platform/react-hooks/LICENSE

This file was deleted.

0 comments on commit 76a5475

Please sign in to comment.