docs(readme): update docs with instructions for app start

nongrata081 · Jul 4, 2019 · 07bbc5e · 07bbc5e
1 parent 659af09
commit 07bbc5e
Show file tree

Hide file tree

Showing 10 changed files with 129 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,19 @@
 # NgAssessment
 
+# Prerequisites
+
+To start the app required are:
+
+- [email protected]
+- [email protected]
+
+## Start app
+
+Run `npm start` to start the application. This will start:
+
+- fake rest api server at http://localhost:3000
+- angular app at http://localhost:4200
+
 ## Guidelines for monorepo
 
 [Enterprise angular monorepo patterns](enterprise-angular-mono-repo-patterns.pdf)

diff --git a/a11y/pa11y-test-report.html b/a11y/pa11y-test-report.html
@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+
+	<meta charset="utf-8"/>
+	<title>Accessibility Report For "http://localhost:4200/" (Tue Jul 02 2019 21:07:45 GMT+0200 (Central European Summer Time))</title>
+
+	<style>
+
+		html, body {
+			margin: 0;
+			padding: 0;
+			background-color: #fff;
+			font-family: Arial, Helvetica, sans-serif;
+			font-size: 16px;
+			line-height: 22px;
+			color: #333;
+		}
+		li {
+			margin-bottom: 15px;
+		}
+		h1, h2, p, pre, ul {
+			margin-top: 0;
+			margin-bottom: 0;
+		}
+		h1 {
+			margin-bottom: 10px;
+			font-size: 24px;
+			line-height: 24px;
+		}
+		h2 {
+			font-size: 16px;
+		}
+		pre {
+			white-space: pre-wrap;
+			overflow: auto;
+		}
+
+		.page {
+			max-width: 800px;
+			margin: 0 auto;
+			padding: 25px;
+		}
+
+		.counts {
+			margin-top: 30px;
+			font-size: 20px;
+		}
+		.count {
+			display: inline-block;
+			padding: 5px;
+			border-radius: 5px;
+			border: 1px solid #eee;
+		}
+
+		.clean-list {
+			margin-left: 0;
+			padding-left: 0;
+			list-style: none;
+		}
+		.results-list {
+			margin-top: 30px;
+		}
+
+		.result {
+			padding: 10px;
+			border-radius: 5px;
+			border: 1px solid #eee;
+		}
+		.error {
+			background-color: #fdd;
+			border-color: #ff9696;
+		}
+		.warning {
+			background-color: #ffd;
+			border-color: #e7c12b;
+		}
+		.notice {
+			background-color: #eef4ff;
+			border-color: #b6d0ff;
+		}
+
+	</style>
+
+</head>
+<body>
+
+	<div class="page">
+
+		<h1>Accessibility Report For "http://localhost:4200/"</h1>
+		<p>Generated at: Tue Jul 02 2019 21:07:45 GMT+0200 (Central European Summer Time)</p>
+
+		<p class="counts">
+			<span class="count error">1 errors</span>
+			<span class="count warning">0 warnings</span>
+			<span class="count notice">0 notices</span>
+		</p>
+
+		<ul class="clean-list results-list">
+			<li class="result error">
+				<h2>Error: Img element missing an alt attribute. Use the alt attribute to specify a short text alternative.</h2>
+				<p>WCAG2AA.Principle1.Guideline1_1.1_1_1.H37</p>
+				<pre>&lt;img _ngcontent-serverapp-c0=&quot;&quot; src=&quot;&quot;&gt; (select with "html &gt; body &gt; ship-root &gt; img")</pre>
+			</li>
+		</ul>
+
+	</div>
+
+</body>
+</html>
+
diff --git a/libs/ui-components/src/lib/components/package-form/package-form.component.html b/libs/ui-components/src/lib/components/package-form/package-form.component.html
@@ -76,12 +76,7 @@
 </div>
 
 <div>
-	<button
-		mat-raised-button
-		style="margin-right:20px"
-		(click)="addPackage()"
-		[disabled]="disableAddingPackage()"
-	>
+	<button mat-raised-button (click)="addPackage()" [disabled]="disableAddingPackage()">
 		Add package
 	</button>
 	<button

diff --git a/libs/ui-components/src/lib/components/package-form/package-form.component.scss b/libs/ui-components/src/lib/components/package-form/package-form.component.scss
@@ -1,3 +1,4 @@
 button {
 	outline: none;
+	margin-right: 20px;
 }
diff --git a/...src/lib/components/shared-ui-component-example/shared-ui-component-example.component.html b/...src/lib/components/shared-ui-component-example/shared-ui-component-example.component.html
diff --git a/...src/lib/components/shared-ui-component-example/shared-ui-component-example.component.scss b/...src/lib/components/shared-ui-component-example/shared-ui-component-example.component.scss
diff --git a/.../lib/components/shared-ui-component-example/shared-ui-component-example.component.spec.ts b/.../lib/components/shared-ui-component-example/shared-ui-component-example.component.spec.ts
diff --git a/...s/src/lib/components/shared-ui-component-example/shared-ui-component-example.component.ts b/...s/src/lib/components/shared-ui-component-example/shared-ui-component-example.component.ts
diff --git a/libs/ui-components/src/lib/ui-components.module.ts b/libs/ui-components/src/lib/ui-components.module.ts
@@ -1,6 +1,5 @@
 import { NgModule } from '@angular/core';
 import { CommonModule } from '@angular/common';
-import { SharedUiComponentExampleComponent } from './components/shared-ui-component-example/shared-ui-component-example.component';
 import { HeaderComponent } from './components/header/header.component';
 import { MDBBootstrapModule } from 'angular-bootstrap-md';
 import { FooterComponent } from './components/footer/footer.component';
@@ -21,14 +20,12 @@ import { HttpClientModule } from '@angular/common/http';
 	],
 	declarations: [
 		HeaderComponent,
-		SharedUiComponentExampleComponent,
 		FooterComponent,
 		ShipmentFormComponent,
 		PackageFormComponent
 	],
 	exports: [
 		HeaderComponent,
-		SharedUiComponentExampleComponent,
 		FooterComponent,
 		ShipmentFormComponent,
 		PackageFormComponent

diff --git a/package.json b/package.json
@@ -21,7 +21,7 @@
 		"backstop:test:ci": "./node_modules/backstopjs/cli/index.js test",
 		"backstop:approve": "yarn backstop approve",
 		"backstop:open:latest": "yarn backstop openReport",
-		"a11y:test": "./node_modules/pa11y/bin/pa11y.js --reporter html http://localhost:4000/ > a11y/pa11y-test-report.html",
+		"a11y:test": "./node_modules/pa11y/bin/pa11y.js --reporter html http://localhost:4200/ > a11y/pa11y-test-report.html",
 		"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Custom app scripts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~": "",
 		"fake:rest:api": "./node_modules/json-server/lib/cli/bin.js --watch fake-rest-api/endpoints.json",
 		"shipping:hmr": "ng serve shipping --configuration hmr",
@@ -38,7 +38,7 @@
 		"test:coverage": "ng test --code-coverage",
 		"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ NX ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~": "",
 		"ng": "ng",
-		"start": "ng serve --o",
+		"start": "npm run fake:rest:api & ng serve --o",
 		"build": "ng build",
 		"test": "ng test --passWithNoTests",
 		"lint": "nx lint && ng lint",