Merge pull request #64 from amosproj/sprint-06-release-candidate

Sprint 06 release candidate into main branch

README.md

@@ -31,3 +31,77 @@ Non-functional properties of the software shall be:
       ● Can be integrated into other web applications
 
 The computer science department would like to use this viewer to display its 50 years of computer science department exhibition on the web.
+
+# 3D Panorama Viewer | AMOS Project 5
+## Software Build and Deployment Document
+
+- [Project Repository](#project-repository)
+- [Bill of Material](#bill-of-material)
+
+
+# Project Repository
+
+
+## Github organisation structure
+
+### base folder: [/main](https://github.com/amosproj/amos-ss2021-3d-viewer/find/main):
+
+-   **/deliverables**:
+    textual deliverables, i.e. documents (pdf, doc, etc.), or software deliverables
+
+
+-   **/assets**:
+    manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files, and image files
+
+-   **/src**:
+    stands for source, and is the raw code before minification or concatenation or some other compilation - used to read/edit the code
+
+
+-   **/gitignore**:
+  is a text file that tells Git which files or folders to ignore in a project
+
+
+-   **/license**:
+    MIT License
+    A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.
+
+
+##  Folder Structure
+### base folder: [/src](https://github.com/amosproj/amos-ss2021-3d-viewer/tree/main/src): Frontend
+
+It includes css(inside PanoViewer div),js,libs and index.html
+
+*  **/src/js/viewer**:
+  includes the general viewer files
+
+*  **/src/libs**:
+  includes jQuery and Three.js Library files
+
+
+## Folder Structure
+
+### base folder: [/src](https://github.com/amosproj/amos-ss2021-3d-viewer/tree/main/src/js): Backend
+
+Includes the js files and main.js
+
+
+
+# Bill of Material
+
+- [Node.js](https://nodejs.org/en/): JavaScript runtime environment Backend
+
+- [the three.js NPM package](https://www.npmjs.com/package/three): JavaScript library and API for animated 3D graphics
+
+- [WebGL Overview - The Khronos Group Inc](https://www.khronos.org/webgl/): JavaScript API for rendering interactive 2D and 3D graphics
+
+- [License | jQuery Foundation](https://jquery.org/license/): JavaScript library for simple HTML DOM manipulation
+
+- [org.w3c.dom (Java Platform SE 8 ](https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/package-summary.html): Web APIs frontend for display Visualizations basics
+
+
+
+You can find further details about the project in the associated documents.
+
+1. [User Documentation](https://github.com/amosproj/amos-ss2021-3d-viewer/wiki/User-Documentation)
+2. [Build/Deployment Documentation](https://github.com/amosproj/amos-ss2021-3d-viewer/wiki/Build--deploy-Documentation)
+3. [Technical Documentation](https://github.com/amosproj/amos-ss2021-3d-viewer/wiki/Technical-Documentation)

src/css/main.css

@@ -22,3 +22,10 @@ body {
     cursor: -webkit-grabbing;
 }
 
+.control{
+    position: fixed;
+    bottom: 40%;
+    right: 3%;
+    color: #fff;
+}
+

src/index.html

@@ -10,6 +10,14 @@
         <script src="libs/jQuery.min.js"></script>
         <script type="module" src="js/main.js"></script>
 
-        <div id="pano-viewer"></div>
+        <div id="pano-viewer">
+            <div class = "control">
+                <div id="nof"></div>
+                <div id="cf"></div>
+                <button name="buttonUp">Up</button>
+                <button name="buttonDown">Down</button>
+                <select name="dropdown" id="dropdown-floors"></select>
+            </div>
+        </div>
     </body>
 </html>