From 87d451ac4a10ab4826fa64fac66e990cfadd3cca Mon Sep 17 00:00:00 2001 From: Ila Date: Wed, 15 Nov 2023 20:56:24 +0100 Subject: [PATCH] updated readme (#476) --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 864007a48..4a57debbf 100644 --- a/README.md +++ b/README.md @@ -111,15 +111,15 @@ A **POST** API which takes a SQL statement to create a database/table/view in th 1. Clone [Coral repo](https://github.com/linkedin/coral) ```bash git clone https://github.com/linkedin/coral.git -``` +``` 2. From the root directory of Coral, access the coral-service module ```bash cd coral-service -``` +``` 3. Build ```bash ../gradlew clean build -``` +``` #### To run Coral Service using the **local metastore**: 4. Run ```bash @@ -132,7 +132,7 @@ cd coral-service 6. Run ``` ../gradlew bootRun -``` +``` You can also specify a custom location of `hive.properties` file through `--hivePropsLocation` as follows ``` ./gradlew bootRun --args='--hivePropsLocation=/tmp/hive.properties' @@ -148,6 +148,12 @@ or `../gradlew bootRun` (for remote metastore mode) from coral-service module, c 2. Copy over the template from `.env.local.example` into the new `.env.local` file 3. Fill in the environment variable values in `.env.local` +#### Install the required packages in the frontend directory: + +```bash +npm install +``` + #### Now you can start the Coral Service UI by running: ```bash npm run dev