jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add web UI for Gamestonk Terminal (#1251)

Browse Source 
* Add web version of Gamestonk Terminal

* Update README.md

* Update README.md

* Fix typos, improve formatting

* Add trailing newline to index.html

* Split up long line

* Add comments to launch script

* Update README.md

Co-authored-by: didierlopes.eth <dro.lopes@campus.fct.unl.pt>
Co-authored-by: Chavithra <chavithra@gmail.com>
This commit is contained in:
Arjun V
2022-01-23 18:44:36 -08:00
committed by GitHub
parent abbc44be50
commit 74f028ddb1
8 changed files with 123 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md vendored
View File

@@ -66,6 +66,7 @@
<ul>
<li><a href="#docker-installation">Docker Installation</a></li>
<li><a href="#local-install---anaconda-and-python">Local Install - Anaconda and Python</a></li>
<li><a href="#web-ui---docker">Web UI - Docker</a></li>
<li><a href="#advanced-user-install---machine-learning">Advanced User Install - Machine Learning</a></li>
<li><a href="#update-terminal">Update Terminal</a></li>
<li><a href="#api-keys">API Keys</a></li>
@@ -101,6 +102,7 @@ There are currently two main options to install the terminal:
* using Docker: recommended if you just want to use the terminal
* using Python: recommended if you want to develop new features
* using the Docker web UI: recommended if you want to deploy the web UI for users to access over your LAN
First step in both options is to star the project
@@ -158,6 +160,20 @@ This installation type supports both Windows and Unix systems (Linux + MacOS). H
If you are using macOS or other Linux operating systems you can jump the next section <a href="#installing-the-terminal">Installing the terminal</a>.
### Web UI - Docker
1. Ensure Docker is installed.
2. Navigate to the location of the Dockerfile in the repo (`cd gamestonk_terminal_web`)
3. Ensure the launcher is executable with `chmod +x ./launch`
4. Launch it with `./launch`. If you get a permission denied error, do `sudo ./launch` instead
5. Once it's launched, you will be able to access it by going to `http://host-ip:8080` in a browser, or `http://localhost:8080` if you are running it on your local machine.
For API keys, create the `setenv` file if it doesn't already exist.
It will automatically get created on the first launch, and won't get committed to Git because it is on the `.gitignore`.
Set the API keys [as explained here](https://github.com/GamestonkTerminal/GamestonkTerminal/blob/main/DOCKER_ADVANCED.md#environment-variables).
Once you've put the API keys in that file, re-run the launch script, and it will use your API keys.
There are a few things that still don't work, and you can see what works and what doesn't [here](https://github.com/CoconutMacaroon/GamestonkTerminal/blob/main/gamestonk_terminal_web/README.md#todo).
#### Installing WSL (Only for Windows users)
If you are using Windows you first you need to install WSL. The process is simple and a tutorial can be found [here](https://www.sitepoint.com/wsl2/). Once you reach the section **Update Linux** on that tutorial, you should have a linux machine installed and can proceed to the next steps.