Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.55 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.55 KB
Raw

ddf-ui

Welcome to ddf-ui, the home of Intrigue.

Installing in DDF

Note: Change 4.1.0-SNAPSHOT to the desired or most recent version of ddf-ui.

  1. Inside of a DDF karaf console run the following commands:

    feature:repo-add mvn:org.codice.ddf.search/intrigue-ui-app/4.1.0-SNAPSHOT/xml/features

    feature:install catalog-ui-app

    This will add the backend repo and then install the app.

    feature:repo-add mvn:org.codice.ddf.search/ui-frontend/4.1.0-SNAPSHOT/xml/features

    feature:install ui-frontend

    This will add the frontend repo and then install the app.

  2. (Optional) Add the following bundle to bundleLocations in etc/application-definitions/search-ui.json:

    "mvn:org.codice.ddf.search/catalog-ui-search/4.1.0-SNAPSHOT"

    This configures the Intrigue configurations to appear under the Search UI app in the DDF Admin Console.

  3. (Optional) Add a configuration file at etc/org.codice.ddf.ui.searchui.filter.RedirectServlet.config with the following contents:

    defaultUri="${org.codice.ddf.external.context}/search/catalog/"

    This configures /search to redirect to /search/catalog, which is the URI for Intrigue.

Developer Notes

There are multiple workflows setup to assist with develop in downstream projects.

  1. The first work flow is one that runs on each pull request. After each commit, the catalog-ui-search dist will be built and pushed to a branch unique to that pull request. This branch is automatically maintained and deleted once the pull request closes (merged or otherwise). An example comment that is posted to each pull request once the branch is built and pushed is below
An updated dist branch has been created and pushed to origin.
You can use:
`"catalog-ui-search": "https://github.com/codice/ddf-ui#catalog-ui-search-dist-746"`,
in your package.json to use this version in your project.

Remember to use "yarn install --force" if you want to pick up changes each time you make a change to this branch by committing.
  1. There is a similar workflow that maintains a dist for the main branch of the project. So once your changes are merged in, you can point to this branch. Or you can point to it just to verify the next version will work once released. Below is how to reference that snapshot dist.
 "catalog-ui-search": "codice/ddf-ui#main-dist-snapshot"

Remember that both cases rely on using yarn install --force to pick up any changes to the branches.
(and also remember to wait for the rebuilt dist to be compiled and pushed)