yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-28 16:08:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

UI doc (#2454)

Browse Source 
* GitBook: [#1] Addressed npm to yarn changes

* GitBook: [#2] Minor changes

* backend doc path change
This commit is contained in:
parthp2107 2022-01-26 18:39:16 +05:30 committed by GitHub
parent 2d43b208c0
commit 6827297f37
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/SUMMARY.md
View File

@ -130,7 +130,7 @@
* [Community](open-source-community/community.md)
* [Developer](open-source-community/developer/README.md)
* [How to Contribute](open-source-community/developer/how-to-contribute.md)
* [Backend](docs/open-source-community/developer/backend/README.md)
* [Backend](open-source-community/developer/backend/README.md)
* [Build the code & run tests](open-source-community/developer/build-code-run-tests.md)
* [Quick Start Guide](open-source-community/developer/quick-start-guide.md)
* [Build a Connector](open-source-community/developer/build-a-connector/README.md)

2
docs/open-source-community/developer/backend.md Normal file
View File

@ -0,0 +1,2 @@
# Backend

24
docs/open-source-community/developer/run-openmetadata-ui-locally.md
View File

@ -6,15 +6,15 @@ description: This guide will help you to run OpenMetadata UI locally.
### **Pre-requisites**
Before proceeding, ensure that you have installed the node and npm with the versions given below.
Before proceeding, ensure that you have installed the node and yarn with the versions given below.
```
"node": ">=10.0.0",
"npm": "^6.0.0"
"yarn": "^1.22.0"
```
****[**Install Node**](https://nodejs.org/en/download/)****\
****[**Install Npm**](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)****
[**Install Node**](https://nodejs.org/en/download/)\
[**Install Yarn**](https://classic.yarnpkg.com/lang/en/docs/install/)****
Using the command below, spin up the server locally from the directory.`openmetadata-dist/target/openmetadata-*-SNAPSHOT`.
@ -29,26 +29,22 @@ Using the command below, spin up the server locally from the directory.`openmeta
### **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.
Once the node and yarn 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.\
****
**Step 1**: 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
> make yarn_install_cache
```
**Step 2**: Start the local server
**Step 2**: Start the UI locally
```shell
# starting a local server
> npm run start
# starting the UI locally
> make yarn_start_dev_ui
```
**Step 3:** Visit [localhost:3000](http://localhost:3000) to access the OpenMetadata UI.