Merge pull request #66 from elastic/workplace-ui

Workplace UI

Author: yansavitski

.gitignore

@@ -1,3 +1,3 @@
 # osx
-
+.idea
 .DS_Store

example-apps/workplace-search/README.md

@@ -13,45 +13,26 @@ curl https://codeload.github.com/elastic/elasticsearch-labs/tar.gz/main | \
 tar -xz --strip=2 elasticsearch-labs-main/example-apps/workplace-search
 ```
 
-## 2. Index Data
+## 2. Credentials
 
-You can index the data from the provided .json files by following the [README](./example-data/README.md) instructions in the `example-data` folder. At the moment indexing your own data should be possible. The UI will attempt to use the URL in the data file for the HTML link to the source.
+This app requires the following environment variables to be set:
 
-### Loading your own data
-
-See the [medicare](./example-data/README.md#loading-custom-data) example in the example-data folder for loding your own data.
-
-## 3. Credentials
-
-Requires the following environment variables to be set. This can be done by creating a `.env` file in the `/api` directory of the project.
-
-### Setup with OpenAI
+```sh
+export ELASTIC_CLOUD_ID=...
+export ELASTIC_USERNAME=...
+export ELASTIC_PASSWORD=...
+export OPENAI_API_KEY=...
+```
 
-You can get your OpenAI key from the [OpenAI dashboard](https://platform.openai.com/account/api-keys).
+Note: you can get your OpenAI key from the [OpenAI dashboard](https://platform.openai.com/account/api-keys).
 
-```
-openai_type=openai
-openai_api_model="gpt-3.5-turbo-0613"
-openai_api_key=<your-openai-key>
-cloud_id=<elasticsearch-cloud-id>
-cloud_pass=<elasticsearch-password>
-cloud_user=<elasticsearch-user>
-```
 
-### Setup with Azure OpenAI Credentials
+## 3. Index Data
 
-You can get your Azure OpenAI key from the [Azure OpenAI dashboard](https://ms.portal.azure.com/#blade/Microsoft_Azure_Marketplace/GalleryFeaturedMenuItemBlade/selectedMenuItemId/home/searchQuery/openai/resetMenuId/).
+You can index the data from the provided .json files in the `data` folder:
 
-```
-openai_type=azure
-openai_api_key=<your openai api key>
-openai_api_type=azure
-openai_api_base=<your openai api base url>
-openai_api_version=2023-03-15-preview
-openai_api_engine=<your openai api engine>
-cloud_id=<elasticsearch-cloud-id>
-cloud_pass=<elasticsearch-password>
-cloud_user=<elasticsearch-user>
+```sh
+python data/index-data.py
 ```
 
 ## Developing
@@ -65,18 +46,33 @@ With the environment variables set, you can run the following commands to start
 
 ### Install the dependencies
 
+For Python we recommend using a virtual environment.
+
+_ℹ️ Here's a good [primer](https://realpython.com/python-virtual-environments-a-primer) on virtual environments from Real Python._
+
+```sh
+# Create a virtual environment
+python -m venv .venv
+
+# Activate the virtual environment
+source .venv/bin/activate
 ```
-cd api && pip3 install -r requirements.txt
+
+```sh
+# Install Python dependencies
+pip install -r requirements.txt
+
+# Install Node dependencies
 cd frontend && yarn
 ```
 
 ### Run API and frontend
 
-```
-cd api && python3 app.py
-
-# in a separate terminal
+```sh
+# Launch API app
+python api/app.py
 
+# In a separate terminal launch frontend app
 cd frontend && yarn start
 ```