initial commit

rhappdev · Apr 1, 2019 · 5084800 · 5084800
commit 5084800
Show file tree

Hide file tree

Showing 10 changed files with 5,069 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+_book
+node_modules
diff --git a/README.md b/README.md
@@ -0,0 +1,5 @@
+# AppDevCoE: Contract-First workshop
+
+This is a AppDevCoE workshop where you will be building a client and cloud application by using Contract-First development approach. Hopefully the workshop will help you to get insight into how to document your APIs, utilize SDKs to consume APIs based on specification and lastly how to test the endpoints based on API specification.
+
+
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -0,0 +1 @@
+docs/README.md
diff --git a/book.json b/book.json
@@ -0,0 +1,9 @@
+{
+  "gitbook": "3.x.x",
+	"title": "Contract-First workshop",
+  "plugins": ["prism", "-highlight", "github", "ga"],
+
+	"theme-default": {
+		"showLevel": true
+	}
+}
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,5 @@
+# Table of content
+
+* [Overview](/docs/overview.md)
+* [Environment](/docs/environment.md)
+
diff --git a/docs/congratulations.md b/docs/congratulations.md
@@ -0,0 +1,4 @@
+# Congratulations!
+
+You have now completed the contract-first workshop. Hopefully you now have some understanding of how and when to use the contract-first development approach. 
+
diff --git a/docs/environment.md b/docs/environment.md
@@ -0,0 +1,9 @@
+# Environment
+
+First, let's set define our environment so that we are all on the same page.
+
+**You will need:**
+* Node.js version 8.
+* Your web editor of choice, [VS Code](https://code.visualstudio.com/) is a great pick for front-end development
+* A web browser e.g. [Google Chrome](https://www.google.se/chrome/browser/desktop/)
+* [Postman](todo)
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,13 @@
+# Overview
+
+In this workshop you will learn how to build an end-to-end solution application in nodejs and angular with openAPI specification. 
+. You will make every component from scratch but will be provided boilerplate for each step so that you can focus entirely on learning how to develop using contract-first approach.
+
+**You will learn how to**
+ * Build a nodejs app from scratch using [todo:oas-tools](https://www.npmjs.com/package/oas-tools) module. The module allows to support REST API defined with openAPI spec.
+ * Use [swagger-codegen](https://swagger.io/tools/swagger-codegen) to generate server stubs and client SDKS defined for API with OpenAPI. 
+ * Communicate with a backend REST API using the Angular client SDK generated by swagger-codegen tool.
+ * Use Postman .... 
+
+
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,5 @@
		# AppDevCoE: Contract-First workshop

		This is a AppDevCoE workshop where you will be building a client and cloud application by using Contract-First development approach. Hopefully the workshop will help you to get insight into how to document your APIs, utilize SDKs to consume APIs based on specification and lastly how to test the endpoints based on API specification.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		# Congratulations!

		You have now completed the contract-first workshop. Hopefully you now have some understanding of how and when to use the contract-first development approach.