-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
66 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Dependencies | ||
|
||
## Runtime (Deployment) Dependencies | ||
|
||
All dependencies are cross-platform, open source with permissive licenses so | ||
that developers and data analysts do not need to procure or purchase any tools. | ||
|
||
- Download | ||
[Deno](https://docs.deno.com/runtime/manual/getting_started/installation) | ||
Javascript runtime and put it in your `PATH`. | ||
- Download [DuckDB](https://duckdb.org/docs/installation) 0.9+ for data | ||
orchestration operations and put it in your `PATH`. | ||
- Download [SQLite](https://www.sqlite.org/download.html) embedded database and | ||
put it in your `PATH`. | ||
- Download [SQLPage](https://github.com/lovasoa/SQLpage/releases) SQL browser, | ||
call it `sqlpage` on Linux/MacOS (not the default `sqlpage.bin`) or | ||
`sqlpage.exe` on Windows and put it in your `PATH`. | ||
- SQLPage is not strictly required but highly recommended for easier | ||
diagnostics. See _Manage GitHub binaries with `eget`_ for an easy way to | ||
manage GitHub binaries. | ||
|
||
The utilities mentioned above are cross-platform single-file binaries and will | ||
run on Windows, MacOS, or Linux. Please be sure to get the proper binaries for | ||
your platform. | ||
|
||
You can run `deno task doctor` (see below) to see if dependencies are installed | ||
properly. | ||
|
||
### Manage GitHub binaries with `eget` | ||
|
||
A good way to get binaries from GitHub (e.g. SQLPage, et. al.) you should | ||
download and use [eget](https://github.com/zyedidia/eget/releases). | ||
|
||
1. Create a directory called `D:\bin` or `C:\Program Files\qe-cs` (or anywhere | ||
you want), grab the `eget.exe` binary and store it in `D:\bin`. | ||
2. Add `D:\bin` or `C:\Program Files\qe-cs` (or whatever you created in step #1) | ||
to your `PATH`. | ||
3. Create an `D:\bin\eget.toml` file (or `C:\Program Files\qe-cs\eget.toml`) and | ||
add the following content. Be sure to set `target = "X"` where X is either | ||
`D:\\bin` or `C:\\Program Files\\qe-cs` (or whatever you created in step #1). | ||
|
||
```toml | ||
[global] | ||
target = "D:\\bin" | ||
|
||
["lovasoa/SQLpage"] | ||
``` | ||
|
||
4. CD into `D:\bin` (or `C:\\Program Files\\qe-cs` or whatever you created in | ||
step #1) and run `eget /D` to download all required binaries. | ||
|