Skip to content

Commit 4c812c8

Browse files
seafooxsarahdayan
andauthored
docs(examples): add missing READMEs (#926)
Co-authored-by: Sarah Dayan <[email protected]>
1 parent 5cefb2f commit 4c812c8

File tree

4 files changed

+76
-0
lines changed

4 files changed

+76
-0
lines changed

examples/starter-algolia/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Autocomplete starter with Algolia index
2+
3+
This example helps you quickly boostrap a basic Autocomplete experience using Algolia.
4+
5+
<p align="center"><img src="capture.jpg" alt="A capture of the Autocomplete with Algolia" /></p>
6+
7+
## Demo
8+
9+
[Access the demo](https://codesandbox.io/s/github/algolia/autocomplete/tree/next/examples/starter-algolia)
10+
11+
## How to run this example locally
12+
13+
### 1. Clone this repository
14+
15+
```sh
16+
git clone [email protected]:algolia/autocomplete.git
17+
```
18+
19+
### 2. Install the dependencies and run the server
20+
21+
```sh
22+
yarn
23+
yarn workspace @algolia/autocomplete-example-starter-algolia start
24+
```
25+
26+
Alternatively, you may use npm:
27+
28+
```sh
29+
cd examples/starter-algolia
30+
npm install
31+
npm start
32+
```
33+
34+
Open <http://localhost:1234> to see your app.
35+
36+
## Additional resources
37+
Learn more [how to get started with Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/getting-started/) in the Algolia documentation.
38+

examples/starter-algolia/capture.jpg

170 KB
Loading

examples/starter/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Autocomplete starter with static data
2+
3+
This example helps you quickly boostrap a basic Autocomplete using static data.
4+
5+
<p align="center"><img src="capture.jpg" alt="A capture of the Autocomplete starter using static data" /></p>
6+
7+
## Demo
8+
9+
[Access the demo](https://codesandbox.io/s/github/algolia/autocomplete/tree/next/examples/starter)
10+
11+
## How to run this example locally
12+
13+
### 1. Clone this repository
14+
15+
```sh
16+
git clone [email protected]:algolia/autocomplete.git
17+
```
18+
19+
### 2. Install the dependencies and run the server
20+
21+
```sh
22+
yarn
23+
yarn workspace @algolia/autocomplete-example-starter start
24+
```
25+
26+
Alternatively, you may use npm:
27+
28+
```sh
29+
cd examples/starter
30+
npm install
31+
npm start
32+
```
33+
34+
Open <http://localhost:1234> to see your app.
35+
36+
## Additional resources
37+
Learn more [how to get started with Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/getting-started/) in the Algolia documentation.
38+

examples/starter/capture.jpg

20.4 KB
Loading

0 commit comments

Comments
 (0)