diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 865b825004e..6cea36292c1 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -121,6 +121,7 @@ * [Community](open-source-community/community.md) * [Developer](open-source-community/developer/README.md) + * [Run OpenMetadata UI Locally](open-source-community/developer/run-openmetadata-ui-locally.md) * [How to Contribute](open-source-community/developer/how-to-contribute.md) * [Coding Style](open-source-community/developer/coding-style.md) * [Build the code & run tests](open-source-community/developer/build-code-run-tests.md) diff --git a/docs/open-source-community/developer/run-openmetadata-ui-locally.md b/docs/open-source-community/developer/run-openmetadata-ui-locally.md new file mode 100644 index 00000000000..07b95d66929 --- /dev/null +++ b/docs/open-source-community/developer/run-openmetadata-ui-locally.md @@ -0,0 +1,54 @@ +--- +description: This guide will help you to run OpenMetadata UI locally. +--- + +# Run OpenMetadata UI Locally + +### **Pre-requisites** + +Before proceeding, ensure that you have installed the node and npm with the versions given below. + +``` +"node": ">=10.0.0", +"npm": "^6.0.0" +``` + +****[**Install Node**](https://nodejs.org/en/download/)****\ +****[**Install Npm**](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)**** + +Using the command below, spin up the server locally from the directory.`openmetadata-dist/target/openmetadata-*-SNAPSHOT`. + +```shell +# # Non-secure mode +./bin/openmetadata-server-start.sh conf/openmetadata.yaml +# # Secure mode +./bin/openmetadata-server-start.sh conf/openmetadata-security.yaml +``` + +> Since typescript is heavily used in the OpenMetadata project, we generate the typescript types and the interface from JSON schema. We use the `QuickType` tool to generate the typescript types and interface. You can view the complete instructions [here](https://docs.open-metadata.org/open-source-community/developer/generate-typescript-types-from-json-schema) + +### **Steps to Run OpenMetadata UI** + +Once the node and npm is installed in the system, you can go ahead and perform the following steps to run OpenMetadata UI. + +**Step 1**: Go to `openmetadata-ui/src/main/resources/ui/` and run the given command to install the required dependencies.\ +**** + +**Note:** It’s a one-time task to install dependencies. If there are any changes in the `package.json` file, then again the following steps will have to be performed. + +```shell +# changing directory +> cd openmetadata-ui/src/main/resources/ui/ + +# installing dependencies +> npm install +``` + +**Step 2**: Start the local server + +```shell +# starting a local server +> npm run start +``` + +**Step 3:** Visit [localhost:3000](http://localhost:3000) to access the OpenMetadata UI.