You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+50-72Lines changed: 50 additions & 72 deletions
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Supports customization of the logo image, system name and CSS used
19
19
within the app.
20
20
21
21
Can use either Sqlite or Microsoft SQL Server database for it's own user
22
-
and reports data storage.
22
+
and reports data storage.
23
23
24
24
Database and SSH passwords are stored in its database in encryped form,
25
25
using AES encryption. Users may provide their own key file, or let the
@@ -42,67 +42,56 @@ for more information.
42
42
-[Running the Tests](#running-the-tests)
43
43
-[Running with Docker](/docs/docker.md)
44
44
45
-
### Running from Source
46
-
47
-
To run QueryTree from it's source code, you need the [.NET Core SDK](https://www.microsoft.com/net/download) and [NPM](https://nodejs.org/) installed.
45
+
### Prerequisites
48
46
49
-
You will need to install the Less.js compiler using NPM:
47
+
To build binaries or run from source you need the [.NET Core SDK v2.2](https://www.microsoft.com/net/download) installed.
50
48
51
-
```
52
-
npm install less -g
53
-
```
49
+
### Running from Source
54
50
55
-
Then follow these steps:
51
+
Check you have the prerequisites installed, then follow these steps:
56
52
57
53
1. Clone this repo into a folder
58
54
59
55
2. At the command prompt, cd into the folder, then into the "Web" folder.
60
56
61
57
3. Type:
62
-
58
+
63
59
```sh
64
60
dotnet run
65
61
```
66
-
67
-
4. Visit [http://localhost:5000/](http://localhost:5000/) in your browser. You should see the QueryTree application. *Dotnet may decide to run it on a different port if 5000 is not available, check your terminal output.
68
62
69
-
If you would like to run QueryTree with your own local development settings, you can add a Web/usersettings.json file containing a modified copy of appsettings.json. Settings in this file will override appsettings.json. However, this file will be ignored by git.
63
+
4. Dotnet should report that the applicaiton is running, e.g.
70
64
71
-
### Building Binaries
65
+
```sh
66
+
Now listening on: http://localhost:54182
67
+
Application started. Press Ctrl+C to shut down.
68
+
```
72
69
73
-
You may need to build a release binary to be run with the [.NET Core 2.0.x runtime](https://www.microsoft.com/net/download/core#/runtime). These binaries can be used on systems without the full .NET Core SDK. To build the initial binaries you need the [.NET Core SDK](https://www.microsoft.com/net/download) and [NPM](https://nodejs.org/) installed.
70
+
Visit the URL shown in your browser. You should see the QueryTree application.
74
71
75
-
You will need to install the Less.js compiler using NPM:
72
+
If you would like to run QueryTree with your own local development settings, you can add a Web/usersettings.json file containing a modified copy of appsettings.json. Settings in this file will override appsettings.json. However, this file will be ignored by git.
76
73
77
-
```
78
-
npm install less -g
79
-
```
74
+
### Building Binaries
80
75
81
76
To build a release binary from the project root execute:
This will create a release folder in `dist` of all the unpacked QueryTree binaries and its dependencies.
88
83
89
-
90
84
### Running from Binaries
91
85
92
-
QueryTree is built using .NET Core. To run QueryTree on your server
93
-
you will need to install the .NET Core 2.0.x runtime. You can download
94
-
the installer [here](https://www.microsoft.com/net/download/core#/run).
86
+
To run QueryTree on your server you will need to install the .NET Core 2.2.x runtime. (It is not necessary to install the full .NET SDK, just the runtime.) You can download the installer [here](https://www.microsoft.com/net/download/core#/runtime).
95
87
96
-
To verify that you have the .NET runtime installed, open a terminal/cmd
97
-
window and type
88
+
To verify that you have the .NET runtime installed, open a terminal/cmd window and type
98
89
99
-
```
90
+
```sh
100
91
dotnet --version
101
92
```
102
93
103
94
If the command returns a version number, you're ready to run QueryTree.
104
-
If not, please visit [https://www.microsoft.com/net/download/core#/runtime](https://www.microsoft.com/net/download/core#/runtime)
105
-
and follow the instructions for your platform.
106
95
107
96
Once the dotnet runtime is installed, follow these steps:
108
97
@@ -112,11 +101,18 @@ Once the dotnet runtime is installed, follow these steps:
112
101
113
102
3. At the command prompt, type:
114
103
115
-
```
104
+
```sh
116
105
dotnet QueryTree.dll
117
106
```
118
107
119
-
4. Visit [http://localhost:5000/](http://localhost:5000/) in your browser. You should see the QueryTree application.
108
+
4. Dotnet should report that the applicaiton is running, e.g.
109
+
110
+
```sh
111
+
Now listening on: http://localhost:5000
112
+
Application started. Press Ctrl+C to shut down.
113
+
```
114
+
115
+
Visit the URL shown in your browser. You should see the QueryTree application.
120
116
121
117
5. For use in production environments, QueryTree should be run behind a reverse proxy such as nginx. For more information on hosting QueryTree using nginx see: https://docs.microsoft.com/en-us/aspnet/core/publishing/linuxproduction
122
118
@@ -125,9 +121,10 @@ in IIS see: https://docs.microsoft.com/en-us/aspnet/core/publishing/iis
125
121
126
122
### Running the Tests
127
123
128
-
To run the automated tests in this project, cd into the "Tests" folder, then type:
124
+
To run the automated tests in this project, from the project root folder, type the following:
129
125
130
-
```
126
+
```sh
127
+
cd Tests
131
128
dotnet test
132
129
```
133
130
@@ -137,82 +134,63 @@ See the full Docker guide: [docs/docker.md](/docs/docker.md)
137
134
138
135
## Getting Started
139
136
140
-
1. When first run, QueryTree will have no users and no database connections. Visiting
141
-
app, you will be presented with a login page:
137
+
1. When first run, QueryTree will have no users and no database connections. Visiting app, you will be presented with a login page:
3. Having signed in, you won't have any database connections configured. The system
150
-
will ask you whether you want to set up a connection yourself, or invite another user
151
-
who might be able to do it for you.
145
+
3. Having signed in, you won't have any database connections configured. The system will ask you whether you want to set up a connection yourself, or invite another user who might be able to do it for you.
Once all the information is entered, you can check the connection by pressing the
161
-
"Test Connection" button. If the system reports that the conneciton is working,
162
-
press "Save".
153
+
Once all the information is entered, you can check the connection by pressing the "Test Connection" button. If the system reports that the conneciton is working, press "Save".
163
154
164
155
![The QueryTree test connection feature](http://querytreeapp.com/img/screenshots/querytree-test-connection.png"The QueryTree test connection feature")
165
156
166
-
5. You will be taken to the reports list for this connection, but there won't be
167
-
any reports yet.
157
+
5. You will be taken to the reports list for this connection, but there won't be any reports yet.
6. Click on "+ Create Report". You will be taken to the defualt report builder
172
162
173
-
7. All reports start by picking a datbase table to start from. From there
174
-
the report builder will prompt you to select any related tables that it can
175
-
join to. For example, in this screenshot, I have selected the "orders" table
176
-
and QueryTree is prompting me to join the "users" table. QueryTree can see
177
-
that "orders" has a link to "users" so it offers to join the tables.
163
+
7. All reports start by picking a datbase table to start from. From there the report builder will prompt you to select any related tables that it can join to. For example, in this screenshot, I have selected the "orders" table and QueryTree is prompting me to join the "users" table. QueryTree can see that "orders" has a link to "users" so it offers to join the tables.
For more information on how to help QueryTree automatically join between tables
182
-
in your database see [QueryTree's Auto Join feature](/docs/autojoin.md)
167
+
For more information on how to help QueryTree automatically join between tables in your database see [QueryTree's Auto Join feature](/docs/autojoin.md)
183
168
184
-
8. Having selected a starting table, and any relevant related tables, click Next.
185
-
The filter panel will open and you will be prompted to add one or more Filters.
169
+
8. Having selected a starting table, and any relevant related tables, click Next. The filter panel will open and you will be prompted to add one or more Filters.
9. Once you are happy with the filters, you have the option to summarize the data
190
-
that is being shown in the results panel. Summerizing the data can mean totaling,
191
-
averaging, counting or finding the minimum/maximum values, for one or more columns.
192
-
You can do this for all the data, or for different groups of values. For example,
193
-
you could find the average value of the orders, for each country.
173
+
9. Once you are happy with the filters, you have the option to summarize the data that is being shown in the results panel. summerizing the data can mean totaling, averaging, counting or finding the minimum/maximum values, for one or more columns. You can do this for all the data, or for different groups of values. For example, you could find the average value of the orders, for each country.
0 commit comments