yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-11-27 16:14:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [#5] No subject

Browse Source
This commit is contained in:
Sachin Chaurasiya 2021-12-16 05:48:03 +00:00 committed by gitbook-bot
parent d3623bf3fa
commit baf82a2487
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
2 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/SUMMARY.md
View File

@ -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)

54
docs/open-source-community/developer/run-openmetadata-ui-locally.md Normal file
View File

@ -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.