summaryrefslogtreecommitdiffstats
path: root/docs/tutorials/portal-sdk/architecture.rst
diff options
context:
space:
mode:
authorjsseidel <jsseidel@fastmail.com>2017-09-28 14:31:07 -0400
committerjsseidel <jsseidel@fastmail.com>2017-09-28 14:34:01 -0400
commita3b65e405278eb4b54de869a19b66ed9338dd1a6 (patch)
tree51b694ca9e585bcd76cf6c39ea95974a949d8beb /docs/tutorials/portal-sdk/architecture.rst
parent51d83152697da4f2ef2242471ee43f36e6b64300 (diff)
Added tutorial for portal-sdk apps
Added a tutorial for how to create a basic app using the portal sdk. Change-Id: I52783748760501e57751e19d1eb586d21cbef0d9 Issue-Id: PORTAL-100 Signed-off-by: jsseidel <jsseidel@fastmail.com>
Diffstat (limited to 'docs/tutorials/portal-sdk/architecture.rst')
-rw-r--r--docs/tutorials/portal-sdk/architecture.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/tutorials/portal-sdk/architecture.rst b/docs/tutorials/portal-sdk/architecture.rst
new file mode 100644
index 00000000..ba97157b
--- /dev/null
+++ b/docs/tutorials/portal-sdk/architecture.rst
@@ -0,0 +1,18 @@
+Application architecture
+============================================
+
+When building the tutorial app with the ONAP Portal SDK, you'll be working with:
+
+1. `Spring Framework`_: You'll build a Spring Framework controller, which will handle your database queries and provide the top-level access to your application.
+2. AngularJS_: Support for AngularJS is built into the SDK. AngularJS is a popular and powerful framework that lets developers create dynamic client-side web applications. E.g. Gmail. Unlike server-side frameworks like PHP, almost all GUI interaction is handled by the client in JavaScript.
+3. `Bootstrap UI`_: Bootstrap is a front-end framework that makes designing web pages easier by incorporating extensive CSS.
+4. `Google Charts`_: Google charts makes including graphs in your applications easier.
+5. Gridster_: Although not covered in this tutorial, the ONAP Portal SDK also comes with built-in support for the Gridster JavaScript library, which lets you produce pages with draggable and resizeable layouts from elements spanning multiple columns.
+
+Although the learning curve may seem daunting, the most difficult aspect of creating ONAP Portal SDK web applications is understanding how all the pieces fit together. The various frameworks themselves are not hard to understand. However, how they interact with one another isn't always obvious. If you have a basic grasp of Java, JavaScript, HTML, and CSS, you'll have no trouble.
+
+.. _Spring Framework: https://projects.spring.io/spring-framework/
+.. _AngularJS: https://angularjs.org/
+.. _Bootstrap UI: http://www.bootstrap-ui.com/
+.. _Google Charts: https://developers.google.com/chart/
+.. _Gridster: http://dsmorse.github.io/gridster.js/