Indigo · README

README

This is the readme for Indigo, the business process team. https://github.com/david-fisher/320-S22-Track2

Installation

1. Download Node.js at https://nodejs.org/en/download/
2. Download Git at https://git-scm.com/downloads
3. Clone the repository with git clone https://github.com/david-fisher/320-S22-Track2.git from the command line
4. Navigate to the repository folder in the command line
5. Navigate to the front-end folder from the root folder repository
6. Run npm install from the command line to install dependencies, and wait for it to finish installing (This can take a while, especially on slower internet connections)

Components - Activity Table (/front-end/components/business-process/activity)

Activity Filter

/front-end/components/business-process/activity/activity-filter.js

• Able to filter based on Business Domain, Severity
• Business Domain Selector employs the code in /front-end/components/business-process/common/domain-selector-item.js and /front-end/components/business-process/common/domain-selector.js
• Severity Filter and Checkboxes used employs the code in /front-end/components/business-process/common/severity-selector.js and /front-end/components/business-process/common/checkbox.js

Activity Table

/front-end/components/business-process/activity/activity-table.js

• Severity, Date Created, Business Domain, Application and Activity fields all have toggle headers, which can be sorted in ascending or descending order

Adjustable Frame

/front-end/components/business-process/root/adjustable-frame-gutter.js

• Allows the user to drag the top of the activity table up further in order to inspect the contents easier

Components - DatePicker (/front-end/components/business-process/common/date-picker.js)

• DatePicker popper feature to let user select the date and time by clicking on calendar and clock entries in the popper
• Parsing multiple formats of time
• Time shortcuts ex: “-1h”

Components - Tree (/front-end/components/business-process/tree)

Context Menu

/front-end/components/business-process/tree/tree-context-menu.js

• Drill down hierarchy with “Expand All Children” and “Collapse All Children”

Filter

/front-end/components/business-process/tree/tree-filter.js

• Filter by Start Date and End Date (appropriate error states applied)

Utilities

• Launchpad
• Date options: /indigo-dev/front-end/utils/business-process/date-options.js
• Severity to modularize grid testing: indigo-dev/front-end/utils/business-process/severity.js

Launchpad installation UI documentation: https://github.com/lilingxi01/indigo-ui-docs

How to Run

1. Navigate to the front-end folder from the root folder repository
2. Run npm run dev from the command line
3. Use your browser to go to http://localhost:3000 or whichever URL the command line gives

If anything doesn't work, try running npm update from the front-end folder to ensure that all of the dependencies are up to date.

Backlogged Issues

At the moment, we have no backlogged issues.