|
1 | | -# SEGG |
2 | | -Step function Execution Graph Generator |
| 1 | +# SEGG - Step Function Express Graph Generator |
| 2 | + |
| 3 | +SEGG gives visibility to express each execution of a AWS Step Function Express Workflows making it much easier to build and troubleshoot. This tool will help you see the execution visually similar to the execution graph of a Step Function Standard Worflow provided by AWS, and build applications at a much faster rate. |
| 4 | + |
| 5 | + |
| 6 | +## Getting Started |
| 7 | + |
| 8 | +Click here [SEGG](https://segg.antstack.com/) to navigate to the SEGG Web Portal. |
| 9 | + |
| 10 | + |
| 11 | +### Step 1: Register and Link AWS Account |
| 12 | + |
| 13 | +Register by filling the basic information. On successful registration you will be pointed towards the '1 Click Deploy' that will create an IAM Role in your account for SEGG to access to Step Function Definition and Cloudwatch Logs |
| 14 | + |
| 15 | + |
| 16 | +- #### Security Note |
| 17 | + SEGG assumes the role created to access the Step function definition and the logs, SEGG does not store any session or step function related information. |
| 18 | + |
| 19 | + |
| 20 | +### Step 2: Enter Linked AWS Account Information |
| 21 | + |
| 22 | +After registering and linking the AWS account, the user will be prompted to enter the AWS Account ID, AWS Region and IAM Role Name ( The role created in Step 1 ). The user can use the details to access the application. |
| 23 | + |
| 24 | +### Try SEGG |
| 25 | + |
| 26 | +Enter the information given below in Step 2 of SEGG portal to access the demo application: |
| 27 | +|Key| Value | |
| 28 | +|--|--| |
| 29 | +|AWS Account Id|960351580303| |
| 30 | +|Region|960351580303| |
| 31 | +|IAM Role Name|antstack_stepfunction_readonly| |
| 32 | + |
| 33 | + |
| 34 | +## Libraries |
| 35 | + |
| 36 | +| Name | Function | |
| 37 | +| ------------------- | -------------------------------------------------------------------------------------------------------------- | |
| 38 | +| airtable | Used for storing registered users. | |
| 39 | +| antd | Component Library | |
| 40 | +| react-flow-renderer | Used to generate graphs. | |
| 41 | +| dagre | Used for generating the co ordinates for graph. | |
| 42 | +| react | Help build user interfaces. | |
| 43 | +| react-cookie | Load and save cookies with React. | |
| 44 | +| react-dom | Package that provides DOM specific methods. | |
| 45 | +| react-router-dom | Package contains bindings for using React Router in web applications. | |
| 46 | +| react-scripts | Simply scripts to run the tools required to transform React JSX syntax into plain JavaScript programmatically. | |
| 47 | +| web-vitals | Modular library for measuring all the Web Vitals metrics on real users. | |
0 commit comments