You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> A first-party JavaScript client for building excellent, relevant search experiences with [Elastic App Search](https://www.elastic.co/cloud/app-search-service).
6
7
7
-
The client is compatible with all modern browsers.
8
+
## Contents
8
9
9
-
Note that this library depends on the Fetch API: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API.
10
+
-[Getting started](#getting-started-)
11
+
-[Browser support](#browser-support)
12
+
-[Usage](#usage)
13
+
-[Running tests](#running-tests)
14
+
-[Development](#development)
15
+
-[FAQ](#faq-)
16
+
-[Contribute](#contribute-)
17
+
-[License](#license-)
10
18
11
-
This is not supported by Internet Explorer. If you need backwards compatibility
12
-
for Internet Explorer, you'll need to polyfill the Fetch API with something
13
-
like https://github.com/github/fetch.
19
+
---
14
20
15
-
## Getting Started
21
+
## Getting started 🐣
16
22
17
23
### Install from a CDN
18
24
@@ -46,6 +52,16 @@ var SwiftypeAppSearch = require("swiftype-app-search-javascript");
The specs in this project use [node-replay](https://github.com/assaf/node-replay) to capture responses.
238
+
239
+
The responses are then checked against Jest snapshots.
240
+
241
+
To capture new responses and update snapshots, run:
242
+
243
+
```
244
+
nvm use
245
+
REPLAY=record yarn test -u
246
+
```
247
+
248
+
To run tests:
249
+
250
+
```
251
+
nvm use
252
+
yarn test
253
+
```
254
+
219
255
## Development
220
256
221
257
### Node
222
258
223
-
We depend upon the version of node defined in [.nvmrc](.nvmrc).
259
+
You will probably want to install a node version manager, like nvm.
224
260
225
-
You will probably want to install a node version manager. nvm is recommended.
261
+
We depend upon the version of node defined in [.nvmrc](.nvmrc).
226
262
227
263
To install and use the correct node version with nvm:
228
264
229
265
```
230
266
nvm install
231
267
```
232
268
233
-
### Running Tests
269
+
### Dev Server
270
+
271
+
Install dependencies:
234
272
235
273
```
236
-
nvm use
237
-
yarn test
274
+
yarn
238
275
```
239
276
240
-
### Build
277
+
Run dev server:
278
+
279
+
```
280
+
yarn dev
281
+
```
241
282
242
-
This is run on `prepare` in [package.json](package.json). That means
243
-
this will be run when running `yarn` to install dependencies, and
244
-
also before publishing to npm.
283
+
### Build
245
284
246
285
```
247
286
nvm use
@@ -255,33 +294,29 @@ nvm use
255
294
yarn publish
256
295
```
257
296
258
-
### Adding and updating tests
297
+
##FAQ 🔮
259
298
260
-
The specs in this project use [node-replay](https://github.com/assaf/node-replay) to capture responses.
299
+
### Where do I report issues with the client?
261
300
262
-
The responses are then checked against Jest snapshots.
301
+
If something is not working as expected, please open an [issue](https://github.com/swiftype/swiftype-app-search-javascript/issues/new).
263
302
264
-
To capture new responses and update snapshots, run tests with the following commands:
303
+
### Where can I learn more about App Search?
265
304
266
-
```
267
-
nvm use // Be sure to use the correct version of node
268
-
REPLAY=record yarn test -u
269
-
```
305
+
Your best bet is to read the [documentation](https://swiftype.com/documentation/app-search).
270
306
271
-
##Contributions
307
+
### Where else can I go to get help?
272
308
273
-
To contribute code, please fork the repository and submit a pull request.
309
+
You can checkout the [Elastic App Search community discuss forums](https://discuss.elastic.co/c/app-search).
274
310
275
-
## Development
311
+
## Contribute 🚀
276
312
277
-
Install dependencies
313
+
We welcome contributors to the project. Before you begin, a couple notes...
278
314
279
-
```
280
-
yarn
281
-
```
315
+
- Prior to opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/swiftype/swiftype-app-search-javascript/issues).
316
+
- Please write simple code and concise documentation, when appropriate.
0 commit comments