Simpler distribution by moving things to the /dist folder

akreienbring · Jul 6, 2020 · 92b4514 · 92b4514
1 parent 2fa8feb
commit 92b4514
Show file tree

Hide file tree

Showing 18 changed files with 20 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -64,30 +64,26 @@ I beamed the version number to 2.1.0. because major code reorganization has been
 
 What to download for a minimal installation? 
 * Get the "dist" folder
-* Get the index.html and the startUp.js (the latter only if you want to use the express webserver.. see below)
-* From the "src" folder you'll need the "assets" and the "img" folder.
-* Grab the "src/lib" folder if you want  or get your preferred version of jQuery and Bootstrap and Popper. (Tested with 3.5.1 / 4.5.0 / 1.16.1)
-* All other software (javascript, css and external libs) are bundled in the dbdesigner.js that you'll find in the "dist" folder.
+* In the "dist/lib" folder you'll find jQuery and Bootstrap and Popper. (Tested with 3.5.1 / 4.5.0 / 1.16.1). You can replace them with your favorite versions.
+* All other software (javascript, css and external libs) are bundled in the dbdesigner.js that you'll also find in the "dist" folder.
 
 So the final structure of a minimal installation looks like this:
 ```
 DBDesigner
 |__index.html
 |__startUp.js
-|__dist
-   |__dbdesigner.js
-|__src
-   |__assets
-   |__img
-   |__lib
+|__dbdesigner.js
+|__assets
+|__img
+|__lib
 ```  
 
-You'll need a webserver of your choice to run the tool. However, I included a little Javascript "startUp.js" that uses express to get you started.
+You'll need a webserver of your choice to run the tool. However, I included a little Javascript "startUp.js" that uses express to get you started quickly.
 
 1. Install node.js (with npm) https://nodejs.org
-2. Go to your applicaton root (DBDesigner in the sample above)
+2. Go to your application root (DBDesigner in the sample above)
    - type `npm init` and follow the initialization procedure
-   - type `npm install --save express`
+   - type `npm install [--save] express`
 3. Run the server with `node startUp.js`
 4. Navigate your browser to `localhost:3000`
 
@@ -105,6 +101,6 @@ So far I tested with the current versions of Firefox, Chrome and Edge. And I can
 
 DBDesigner is free and open source, and it always will be. It is licensed under the [GPLv3](https://opensource.org/licenses/GPL-3.0).
 
-André Kreienbring
+Andr� Kreienbring
 
 July, 2020
diff --git a/src/assets/partials/bootui.html → dist/assets/partials/bootui.html b/src/assets/partials/bootui.html → dist/assets/partials/bootui.html
@@ -13,7 +13,7 @@ <h5 class="modal-title" id="popupBoxLabel">DBDesigner</h5>
         	<p class="messageText">Default Message</p>
         </div>
         <div id="popupBoxAbout" class="d-none">
-	        <p style="text-align: center;"><img id="logo" class="img-fluid" style='border-radius:10px;  height: 100px; width:100px' src="src/img/information.svg"/></p>
+	        <p style="text-align: center;"><img id="logo" class="img-fluid" style='border-radius:10px;  height: 100px; width:100px' src="img/information.svg"/></p>
 			<h5 style="margin:0px;">DBDesigner <span class='version'>1.0.0</span></h5>
 			<p class="messageText"><span>Open source, web-based, database diagramming and automation tool.</span></p>
 			<p class="messageText">License: GNU GPLv3</p>

diff --git a/src/assets/partials/resultsDialog.html → dist/assets/partials/resultsDialog.html b/src/assets/partials/resultsDialog.html → dist/assets/partials/resultsDialog.html
diff --git a/src/assets/partials/table.html → dist/assets/partials/table.html b/src/assets/partials/table.html → dist/assets/partials/table.html
diff --git a/src/assets/partials/tableDialog.html → dist/assets/partials/tableDialog.html b/src/assets/partials/tableDialog.html → dist/assets/partials/tableDialog.html
diff --git a/src/assets/templates/mysql.sql → dist/assets/templates/mysql.sql b/src/assets/templates/mysql.sql → dist/assets/templates/mysql.sql
diff --git a/src/assets/templates/sqlalchemy.py → dist/assets/templates/sqlalchemy.py b/src/assets/templates/sqlalchemy.py → dist/assets/templates/sqlalchemy.py
diff --git a/src/assets/templates/sqlite.sql → dist/assets/templates/sqlite.sql b/src/assets/templates/sqlite.sql → dist/assets/templates/sqlite.sql
diff --git a/dist/dbdesigner.js b/dist/dbdesigner.js
diff --git a/dist/dbdesigner.js.map b/dist/dbdesigner.js.map
diff --git a/src/img/information.svg → dist/img/information.svg b/src/img/information.svg → dist/img/information.svg
diff --git a/index.html → dist/index.html b/index.html → dist/index.html
@@ -27,12 +27,12 @@
 	<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js"></script>
 -->	
 
-	<script type="text/javascript" src="src/lib/jquery-3.5.1.min.js"></script>
-	<script type="text/javascript" src="src/lib/popper-1.16.1-lts.min.js"></script>
-	<script type="text/javascript" src="src/lib/bootstrap-4.5.0.min.js"></script>
-	<script type="text/javascript" src="dist/dbdesigner.js"></script>
+	<script type="text/javascript" src="./lib/jquery-3.5.1.min.js"></script>
+	<script type="text/javascript" src="./lib/popper-1.16.1-lts.min.js"></script>
+	<script type="text/javascript" src="./lib/bootstrap-4.5.0.min.js"></script>
+	<script type="text/javascript" src="dbdesigner.js"></script>
 
- 	<link rel="stylesheet" type="text/css" href="src/lib/bootstrap-4.5.0.min.css">
+ 	<link rel="stylesheet" type="text/css" href="./lib/bootstrap-4.5.0.min.css">
 </head>
 
 <body>
@@ -44,7 +44,7 @@
 
 	<nav class="navbar navbar-expand-lg navbar-light bg-light" role="navigation">
 		<div class="container">
-			<a class="navbar-brand" href=""><img id="icon" style="padding: 0px; margin-top: -10px; border-radius: 10px; height: 50px; width:50px" class='img-fluid' src="src/img/information.svg"></a>
+			<a class="navbar-brand" href=""><img id="icon" style="padding: 0px; margin-top: -10px; border-radius: 10px; height: 50px; width:50px" class='img-fluid' src="img/information.svg"></a>
 			<div class="d-flex flex-row order-2 order-lg-3">
 				<form class="slidecontainer form-inline  my-auto ml-4 mr-4">
 						<input type="range" min="0.6" max="1" value="1" step="0.1" class="slider form-control-range" id="zoomSlider">

diff --git a/src/lib/bootstrap-4.5.0.min.css → dist/lib/bootstrap-4.5.0.min.css b/src/lib/bootstrap-4.5.0.min.css → dist/lib/bootstrap-4.5.0.min.css
diff --git a/src/lib/bootstrap-4.5.0.min.js → dist/lib/bootstrap-4.5.0.min.js b/src/lib/bootstrap-4.5.0.min.js → dist/lib/bootstrap-4.5.0.min.js
diff --git a/src/lib/jquery-3.5.1.min.js → dist/lib/jquery-3.5.1.min.js b/src/lib/jquery-3.5.1.min.js → dist/lib/jquery-3.5.1.min.js
diff --git a/src/lib/popper-1.16.1-lts.min.js → dist/lib/popper-1.16.1-lts.min.js b/src/lib/popper-1.16.1-lts.min.js → dist/lib/popper-1.16.1-lts.min.js
diff --git a/startUp.js → dist/startUp.js b/startUp.js → dist/startUp.js
diff --git a/src/index.js b/src/index.js
@@ -26,7 +26,7 @@ import * as pjson from '../package.json';
  */
 jQuery(document).ready(function () {
 	//Construct the Interface with the context and the CSS namespace wrapper.
-	window.dbdesigner = new DBDesigner(document.URL + "src/", ".dbdesigner");
+	window.dbdesigner = new DBDesigner(document.URL + "/", ".dbdesigner");
 	window.dbdesigner.version = pjson.version;
 	window.dbdesigner.app.start();
 });