Git Product home page Git Product logo

egeria-ui's Introduction

Egeria UI

egeria ui build

Library Latest version available
egeria-js-commons egeria-js-commons
egeria-ui-core egeria-ui-core
egeria-ui-components egeria-ui-components
happi-graph happi-graph

Table of contents

  1. Prerequisites
  2. Dependencies
  3. Tests
  4. Development
  5. Production
    1. Standalone build
    2. Preconfigured build with API_URL parameter
  6. Themes
  7. Release cycle
  8. Links
  9. License

Prerequisites

Version
NodeJS 16.13.0 (LTS)
NPM 8.1.0

Dependencies

$ npm install

Tests

$ npm test

Development

Development with backend API

The backend API URL from odpi/egeria (ui-chassis-spring, here [0]), which needs to start with CORS filter on.

$ npm run start --api-url=http://localhost:8443

Development with mocked API

The backend API URL from odpi/egeria-api-mocks (egeria-api-mocks, here [1]).

$ npm run start --api-url=http://localhost:9000

Production

Standalone build

Outputs the build in /build/prod with no config what so ever.

$ npm run build

Preconfigured build with API_URL parameter

Outputs the build with all HTTP requests prefixed with the given API_URL parameter. The API server needs to have the CORS filter on.

npm run build --api-url=http://api.app.prod

Themes

The theme folder now sits statically under the themes folder, changing the files here will change the theme directly. It is directly referenced in the index.html page.

Release cycle

Egeria-UI use GitHub as its dependency provider, this means that all the releases are being pushed to the Github Egeria-UI repository here [2].

$ git clone https://github.com/odpi/egeria-ui     # clone and checkout to main branch
$ vim release-notes.md                            # add release notes
$ git commit -m "Add release notes"
$ npm version patch                               # (minor or major) this will create a new commit with the bumped version
                                                  # and also a git version tag
$ # `npm publish .` won't be executed since we are using GitHub as a direct dependency
$ git push origin main
$ git push origin main --tags
$                                                 # the released version will be available at the git version tag or in the
                                                  # release page here [1]

Links

[0] - https://github.com/odpi/egeria/tree/main/open-metadata-implementation/user-interfaces/ui-chassis/ui-chassis-spring/

[1] - https://github.com/odpi/egeria-api-mocks

[2] - https://github.com/odpi/egeria-ui

License

SPDX-License-Identifier: Apache-2.0

Copyright Contributors to the ODPi Egeria project.

egeria-ui's People

Contributors

sarbull avatar bogdan-sava avatar planetf1 avatar marius-patrascu avatar lcpopa avatar dependabot[bot] avatar ginaisaia avatar mihaiiliescu avatar lpalashevski avatar popa-raluca avatar jmertic avatar tcnt avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.