@digital-realty/ui-mfe-reports 1.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # ui-mfe-dcim
2
+
3
+ This is
4
+
5
+ ## Build status
6
+
7
+ - TODO hook up build status link
8
+
9
+ ## Creation
10
+
11
+ This React + Typescript application was created using [Vite](https://vitejs.dev/).
12
+
13
+ ## Setup
14
+
15
+ To get started:
16
+
17
+ ```sh
18
+ npm install
19
+ ```
20
+
21
+ ## Scripts
22
+
23
+ - `build` builds app and writes the output to the `dist` directory
24
+ - `build:workspace` used by the app shell to excute a build for this MFE
25
+ - `clean` delete `dist` and `node_modules` folders
26
+ - `dev` runs app for development, reloading on file changes
27
+ - `format` runs `prettier` rules on the source code to auto-fix formatting
28
+ - `lint` runs the linter for your project
29
+ - `lint:fix` runs the linter and attempts to fix as many problems as possible
30
+ - `preview` runs app on a local static web server that serves the files from dist at http://localhost:5173; used to check if the production build looks OK in the local environment
31
+ - `start` alias for the `dev` script
32
+ - `test` runs the unit tests
33
+
34
+ ---
35
+
36
+ ## Routes
37
+
38
+ ### DCIM reports
39
+
40
+ Path: `/reports/dcim`
41
+ Example URL: http://localhost:5173/reports/dcim
42
+
43
+ ### Security Reports
44
+
45
+ Path: `/reports/security`
46
+ Example URL: http://localhost:5173/reports/security
47
+
48
+ ### Unmatched routes
49
+
50
+ Any URL path which does not match a known route will redirect to the `/reports/security` route.