azure-search-react-template

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

azure-search-react-template

★ 25 Open GitHub ↗

React template for Azure Cognitive Search

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Azure Cognitive Search UI

This sample is a React template for [Azure Cognitive Search](https://docs.microsoft.com/en-us/azure/search/search-what-is-azure-search). It leverages the [Azure SDK for Javascript/Typescript](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/) and [Azure Static Web Apps](https://aka.ms/swadocs) to make it easy to get up and running with a simple web application.

You can view the resulting web application here: [https://victorious-beach-0ab88b51e.azurestaticapps.net/](https://victorious-beach-0ab88b51e.azurestaticapps.net/)

![Screenshot of sample web app](https://raw.githubusercontent.com/dereklegenzoff/azure-search-react-template/master/images/web-app.png)

You can easily deploy the sample onto Azure or run it locally by following the steps below.

## Running the application locally

To run the sample locally, follow the steps below.

### Prerequisites

- A GitHub account
- [Node.js and Git](https://nodejs.org/)
- [Visual Studio Code](https://code.visualstudio.com/?WT.mc_id=shopathome-github-jopapa) installed
- The [Azure Functions extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions&WT.mc_id=shopathome-github-jopapa) installed
- The [Azure Functions Core Tools](https://docs.microsoft.com/azure/azure-functions/functions-run-local?WT.mc_id=shopathome-github-jopapa) installed

### Setup

1. Clone (or Fork and Clone) this repository

1. Rename the `api/local.settings.json.rename` file to `api/local.settings.json`.

The `local.settings.json` file holds all of the keys that the application needs.

For this sample, there is a search index using the [goodbooks-10k dataset](https://github.com/zygmuntz/goodbooks-10k) that that is publicly available using the connection information below. The index consists of 10,000 popular books that we'll search over in our application.

```json
{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "node",
    "SearchApiKey": "03097125077C18172260E41153975439",
    "SearchServiceName": "azs-playground",
    "SearchIndexName": "good-books",
    "SearchFacets": "authors*,language_code"
  }
}
```

## Run the app locally

This project can be run anywhere, but VS Code is required for local debugging.

1. Open the application with VS Code.

### Running the front-end

1. Install front-end dependencies...

```bash
   npm install
   ```

1. Run the front-end project in the browser (automatically opens a browser window).

```bash
   npm start
   ```

### Running the API

1. From VS Code, press <kbd>F5</kbd>

## Deploying this sample

### Prerequisites

- A GitHub account
- An Azure subscription

### Forking the repo

To start off, select **Use this template** above. This will create your own copy of the code that you can deploy and edit as you please.

![Use this template screenshot](https://raw.githubusercontent.com/dereklegenzoff/azure-search-react-template/master/images/use-template.png)

### Creating the web app

Next, you need to create a Static Web App in the Azure portal. Click the button below to create one:

[![Deploy to Azure button](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/?feature.customportal=false#create/Microsoft.StaticApp)

This will walk you through the process of creating the web app and connecting it to your GitHub repo.

After connecting to the repo, you'll be asked to include some build details. Set the Build Presets to `React` and then leave the other default values:

![Azure Static Web Apps Configuration Screenshot](https://raw.githubusercontent.com/dereklegenzoff/azure-search-react-template/master/images/setup.png)

Once you create the static web app, it will automatically deploy the web app to a URL you can find within the portal.

![Azure Static Web Apps Configuration Screenshot](https://raw.githubusercontent.com/dereklegenzoff/azure-search-react-template/master/images/static-web.png)

The last thing you need to do is select configuration and then edit the application settings to add the credentials from `local.settings.json`. It may take a few minutes for this blade to become available in the portal.

![Azure Static Web Apps Configuration Screenshot](https://raw.githubusercontent.com/dereklegenzoff/azure-search-react-template/master/images/config.png)

Additional documentation can be found in the [docs folder](./docs).

azure-search-react-template

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README