Skip to content

Commit de1f7a8

Browse files
steven-essersteven-esser
committed
Add Welcome Page
* Add basic button layout to handle basic functions * Clean up sidebar buttons and move functionality to Welcome Page Addresses: #290, #306 Signed-off-by: Steven Esser <[email protected]>
1 parent 916200d commit de1f7a8

File tree

3 files changed

+86
-9
lines changed

3 files changed

+86
-9
lines changed

‎assets/app/js/controllers/welcomePage.js‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
#
3+
# Copyright (c) 2019 nexB Inc. and others. All rights reserved.
4+
# https://nexb.com and https://github.com/nexB/scancode-workbench/
5+
# The ScanCode software is licensed under the Apache License version 2.0.
6+
# ScanCode is a trademark of nexB Inc.
7+
#
8+
# You may not use this software except in compliance with the License.
9+
# You may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0
10+
# Unless required by applicable law or agreed to in writing, software distributed
11+
# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
12+
# CONDITIONS OF ANY KIND, either express or implied. See the License for the
13+
# specific language governing permissions and limitations under the License.
14+
#
15+
*/
16+
17+
const Controller = require('./controller');
18+
19+
class WelcomePage extends Controller {
20+
constructor(containerId, workbenchDB) {
21+
super(containerId, workbenchDB);
22+
}
23+
}
24+
25+
module.exports = WelcomePage;

‎assets/app/js/renderer.js‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ const BarChart = require('./controllers/barChart');
2525
const JsTree = require('./controllers/jsTree');
2626
const ScanDataTable = require('./controllers/scanDataTable');
2727
const ConclusionDataTable = require('./controllers/conclusionDataTable');
28+
const WelcomePage = require('./controllers/welcomePage');
2829

2930
const fs = require('fs');
3031
const shell = require('electron').shell;
@@ -96,6 +97,8 @@ $(document).ready(() => {
9697
updateViewsByPath(node.id);
9798
});
9899

100+
const welcomePage = new WelcomePage('#tab-welcomepage', workbenchDB);
101+
99102
$(document).on('click', '#activate-filters-button', () => {
100103
scanDataTable.genFilters();
101104
updateViewsByPath(scanDataTable._selectedPath);
@@ -113,12 +116,17 @@ $(document).ready(() => {
113116
const currentNavButtonId = '#sidebar-wrapper .sidebar-nav .active button';
114117

115118
// Defines DOM element constants for sidebar buttons.
119+
const importJsonButton = $('#import-json');
116120
const saveSQLiteFileButton = $('#save-file');
117121
const openSQLiteFileButton = $('#open-file');
118122
const showScanDataButton = $('#show-tab-scandata');
119123
const showConclusionButton = $('#show-tab-conclusion');
120124
const showBarChartButton = $('#show-tab-barchart');
121125
const showDashboardButton = $('#show-tab-dashboard');
126+
const showWelcomePageButton = $('#show-tab-welcomepage');
127+
128+
// Import a ScanCode JSON resutls file
129+
importJsonButton.click(importJson);
122130

123131
// Open a SQLite Database File
124132
openSQLiteFileButton.click(openSQLite);
@@ -148,6 +156,11 @@ $(document).ready(() => {
148156
dashboard.redraw();
149157
});
150158

159+
showWelcomePageButton.click(() => {
160+
splitter.hide();
161+
});
162+
163+
151164
// Open links in default browser
152165
$('.open-in-default').click((evt) => {
153166
evt.preventDefault();
@@ -165,7 +178,7 @@ $(document).ready(() => {
165178
ipcRenderer.on('get-ScanInfo', getScanInfo);
166179

167180
// Opens the dashboard view when the app is first opened
168-
showDashboardButton.trigger('click');
181+
showWelcomePageButton.trigger('click');
169182

170183
function updateViewsByPath(path) {
171184
// Update all the views with the given path string
@@ -288,6 +301,7 @@ $(document).ready(() => {
288301
}, (fileNames) => {
289302
if (fileNames && fileNames[0]) {
290303
loadDatabase(fileNames[0]);
304+
showDashboardButton.trigger('click');
291305
}
292306
});
293307
}
@@ -369,6 +383,7 @@ $(document).ready(() => {
369383
(progress) => progressbar.update(progress / 100)))
370384
.then(() => progressbar.hide())
371385
.then(updateViews)
386+
.then(showDashboardButton.trigger('click'))
372387
.catch((err) => {
373388
progressbar.hide();
374389
if (err instanceof WorkbenchDB.MissingFileInfoError) {

‎index.html‎

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,8 @@
6262
<div id="sidebar-wrapper">
6363
<ul class="sidebar-nav">
6464
<li>
65-
<button class="btn btn-sidebar" id="open-file" data-toggle="tooltip" data-placement="right" title="Open SQLite File">
66-
<i class="fa fa-folder-open-o" aria-hidden="true"></i>
67-
</button>
68-
</li>
69-
<li>
70-
<button class="btn btn-sidebar" id="save-file" data-toggle="tooltip" data-placement="right" title="Save As New SQLite File">
71-
<i class="fa fa-floppy-o" aria-hidden="true"></i>
65+
<button class="btn btn-sidebar" id="show-tab-welcomepage" data-toggle="tab" data-target="#tab-welcomepage" data-placement="right" title="Welcome Page">
66+
<i class="fa fa-barcode" aria-hidden="true"></i>
7267
</button>
7368
</li>
7469
<li>
@@ -101,7 +96,7 @@
10196

10297
<!-- Main Content -->
10398
<div id="content">
104-
99+
105100
<!-- JsTree -->
106101
<div class="split split-flex" id="leftCol">
107102
<div id="jstree"></div>
@@ -110,6 +105,48 @@
110105
<!-- Tab Bar -->
111106
<div class="tab-content split split-flex" id="rightCol">
112107

108+
<!-- Welcome Page -->
109+
<div class="tab-pane container" id="tab-welcomepage">
110+
<div id="welcomepage-container">
111+
<div id="wecomepage-title">
112+
<h1>Welcome to ScanCode Workbench</h1>
113+
</div>
114+
<div id="welcomepage-view">
115+
<div class="row">
116+
<div class="col-sm-4">
117+
<h3>Start:</h3>
118+
<div class="btn-group-vertical" role="group" aria-label="...">
119+
<button id="import-json" class="btn btn-lg btn-default"><i class="fa fa-cogs"></i> Import ScanCode JSON</button>
120+
<button id="open-file" class="btn btn-lg btn-default"><i class="fa fa-folder"></i> Open SQLite File</button>
121+
<button id="save-file" class="btn btn-lg btn-default"><i class="fa fa-floppy-o"></i> Save SQLite File</button>
122+
</div>
123+
</div>
124+
<div class="col-sm-8">
125+
<h3>Learn:</h3>
126+
<div class="btn-group-vertical" role="group" aria-label="...">
127+
<a href="https://github.com/nexB/scancode-toolkit/wiki/How-To:-Run-a-scan" class="btn btn-lg btn-default">How to run a scan with ScanCode Toolkit</a>
128+
<a href="https://github.com/nexB/scancode-workbench/wiki/ScanCode-Workbench-Views" class="btn btn-lg btn-default">About ScanCode Workbench's various views</a>
129+
<a href="https://github.com/nexB/scancode-workbench/wiki/Creating-Conclusions" class="btn btn-lg btn-default">How to create Conclusions</a>
130+
</div>
131+
</div>
132+
</div>
133+
<div class="row" style="padding-top:50px">
134+
<div class="col-sm-6">
135+
<h4>Additional Help and Documentation:</h4>
136+
<ul>
137+
<li><a href="https://github.com/nexB/scancode-workbench/wiki/">ScanCode Workbench Wiki</a></li>
138+
<li><a href="https://github.com/nexB/scancode-workbench/issues/">ScanCode Workbench Issue Tracker</a></li>
139+
<li><a href="https://github.com/nexB/scancode-workbench/wiki/Check-for-Errors-in-the-Developer-Tools">Checking for Errors</a></li>
140+
</ul>
141+
</div>
142+
<div class="col-sm-6">
143+
<!-- pass -->
144+
</div>
145+
</div>
146+
</div>
147+
</div>
148+
</div>
149+
113150
<!-- ScanData DataTable Tab-->
114151
<div class="tab-pane container" id="tab-scandata">
115152
<table class="scandata-table display table table-striped table-bordered dataTable no-footer" cellspacing="0" width="100%" ></table>

0 commit comments

Comments
 (0)