tree: 755abb047654350251c74e1c599c59746d0d5f76 [path history] [tgz]
  1. e2e/
  2. src/
  3. .dockerignore
  4. .editorconfig
  5. .gitignore
  6. angular.json
  7. package-lock.json
  8. package.json
  9. proxy.conf.json
  10. README.md
  11. tsconfig.json
  12. tslint.json
components/datalake-handler/admin/src/README.md

DataLake Admin UI

DataLake Admin UI aims to provide the administrator with a user-friendly dashboard to easily monitor and manage ONAP topics, database, and tools via REST API from DataLake Feeder backend system.

See more DataLake Proposal on ONAP

Getting Started

  1. Go to project folder and install dependencies:
npm install
  1. Launch development server, and open localhost:4200 in your browser:
npm start

Project Structure

-- app
   -- shared           -----> container of pubilc parts
       -- components          -----> container of pubilc components
           -- alert
           -- toastr-notification
           -- ...more components
       -- modules             -----> container of public business modules
           -- card
           -- modal
           -- search
           -- table
       -- layout              -----> container of basic layout of all pages
           -- header
           -- sidebar
       -- utils               -----> container of general functions
   -- core             -----> container of core functions
       -- models
       -- services
   -- views            -----> container of all business pages
       -- about
       -- dashboard-setting
       -- database
       -- feeder
       -- topics
       -- ...more modules
   -- mockup           -----> mockup data for pages
   -- app-routing.module.ts     -----> container of all pages routers
   -- app-component.css
   -- app-component.html
   -- app-component.ts
   -- app-module.ts
-- assets
   -- i18n
-- index.html
-- main.ts
-- styles.css
-- ...other config documents

The layout is used for organizing a new module, PLEASE take care of the difference between components and modules. Make sure that all parts added in the components are dump components and all the parts which are related to the business should be added in the modules. Good luck 🙂.

The service folder is used for created some reused services. PLEASE put the specific services into the related folders. For example, put the toastr-notification service into the components/toastr-notification folder.

Change log

Git commit message rules

PLEASE obey AngularJS Git Commit Message Conventions when write the commit messages. One commit message should include three parts: Header, Body and Footer. The Header part is necessary, and the other two parts are optional. The Header part follows the rule as: <type>(<scope>): <subject>. type and subject are necessary, scope is optional. Only 7 tokens are allowed for type:

  • feat: new features(feature)
  • fix: fix bugs
  • docs: documentation
  • style: style
  • refactor:reconstruction
  • test:add test
  • chore:change for construction and assistant tools

For example:

feat(directive): ng:disabled, ng:checked, ng:multiple, ng:readonly, ng:selected
----------------------------------------------------- 
docs(guide): updated fixed docs from Google Docs

Couple of typos fixed:
- indentation
- batchLogbatchLog -> batchLog
- start periodic checking
- missing brace

When there is breaking changes in the project, please write the commit message in Footer. For example:

    BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: 'attribute',
    }

    After:

    scope: {
      myAttr: '@',
    }

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

Also, run the script npm run changelog can generate all the feat and fix commits. Click CHANGELOG.md shows all these commit histories.