fixed typo

Merging  master into dockerize

README.md

@@ -2,29 +2,62 @@
 A terminal-style home page replicating the tree command.
 
 <p align="center">
-  <img src="/StartTree.png", title="StartTree"/>
+  <img src="/images/StartTree.png", title="StartTree"/>
 </p>
 
-## TODO
+<div align="center">
-- [x] Add screenshot to README.md
+  <h1>
-- [x] add install script
+    <a href="https://gideonwolfe.com/">
-  - [ ] Should allow selection of search engine
+        <img style="vertical-align:middle" src="/images/forest.png", width="400", />
-  - [x] Should allow for multiple columns
+    </a>
-  - [x] User makes a 'config.yaml' file that is parsed and translated into the HTML
+      <span style=""> 
-  - [ ] Allow setting the font size in the config
+        <img style="vertical-align:middle" src="/images/void.png", width="400", />
-  - [ ] Install the update script into a `$PATH` directory
+        </a>
+      </span>
+  </h1>
+</div>
 
+# Usage
+## Installation
+To install StartTree for the first time, run the following commands:  
+(Note: If the `~/.config/StartTree` directory already exists, `init.py` will not execute to prevent accidentally overwriting a custom config. )
+```
+git clone https://github.com/Paul-Houser/StartTree.git
+cd StartTree
+./init.py
+./generate.py
+```
+This will create the directory `~/.config/StartTree` containing the default `config.yaml`, as well as generate the html/css, which you can view by pointing your browser at `$HOME/.cache/StartTree/index.html`.
+
+## Config
+The config should be placed in `~/.config/StartTree/config.yaml`
+
+## Updating the HTML
+To re-generate the html/css after editing the config, navigate to the `StartTree` directory and execute `./generate.py`.
+
+# Example Config
 ```yaml
-font_size: 15
+font_size: 22 # specify font size
-theme: void
+theme: void # specify the name of a theme in the themes/ directory, or use 'pywal'
-
+tree_1: # each column should be named 'tree_X' where X is unique for each tree.
-Tree_1:
+  general: # Header name
-  General:
+    github: "https://www.github.com/" # Link-text: url
-    Google: "https://www.google.com/"
+    gmail: "https://mail.google.com/"
-    Youtube: "https://www.youtube.com/"
+  reddit:
-  Reddit:
+    # the following is an example of naming a link something with a space,
-    Homepage: "https://www.reddit.com/"
+    # or containing characters that cannot be in a yaml variable name.
-    Unixporn: "https://www.reddit.com/r/unixporn/"
+    frontpage: 
+      - "https://www.reddit.com/"
+      - "front page" # 
+    unixporn: "https://www.reddit.com/r/unixporn/"
+tree_2:
+  other:
+    archwiki: 
+      - "https://archlinux.org/"
+      - "arch wiki"
+    hulu: "https://www.hulu.com/"
+    netflix: "https://www.netflix.com/"
+    youtube: "https://www.youtube.com/"
 ```
 
 # Themes
@@ -32,3 +65,23 @@ Tree_1:
 A variety of themes can be found in the `themes` directory. 
 
 If one wishes to dynamically theme from `pywal`, they may select `pywal` as their chosen theme in `config.yaml`.
+
+# Docker
+
+In order to circumvent some restrictions on browsers for what is allowed as a "Home" and "New Tab" page, you can host StartTree as a lightweight `NGINX` server through `docker-compose`.
+
+To set this up, one must have `docker` and `docker-compose` installed and configured. Then, go into the directory where you cloned `StartTree`, and run
+
+```bash
+cd docker
+vim docker-compose.yaml # edit specifics to your liking
+docker-compose -f docker-compose.yaml up -d
+```
+
+This will make the `NGINX` server persist across reboots. You can point your browser's new tab and home page to `localhost:p<port#>` and you should your startpage!
+
+### NOTE: 
+
+Currently, docker is unaware if a file changes on the fly (like generating a new colorscheme or adding new shortcuts), so you have to restart the container with
+
+`docker-compose -f docker-compose.yaml restart <servicename>`

config.yaml

@@ -1,22 +1,15 @@
-Tree_1:
+font_size: 22
+theme: void
+tree_1:
   general:
-    nextcloud: "https://cloud.paulhouser.xyz/"
+    github: "https://www.github.com/"
-    github: "https://www.github.com/Paul-Houser/"
-    wwu-gitlab: "https://gitlab.cs.wwu.edu/"
     gmail: "https://mail.google.com/"
   reddit:
     frontpage: 
       - "https://www.reddit.com/"
       - "front page"
-    profile: "https://www.reddit.com/u/P_swizzles/"
     unixporn: "https://www.reddit.com/r/unixporn/"
-    archlinux: "https://www.reddit.com/r/archlinux/"
+tree_2:
-Tree_2:
-  school:
-    canvas: "https://wwu.instructure.com/"
-    degreeworks: "https://dw.wwu.edu/Dashboard/dashboard"
-    outlook: "https://outlook.office.com"
-    web4u: "https://admin.wwu.edu/pls/wwis/twbkwbis.P_GenMenu?name=bmenu.P_MainMnu"
   other:
     archwiki: 
       - "https://archlinux.org/"

docker/docker-compose.yaml

@@ -0,0 +1,15 @@
+version: '3'
+services:
+
+  StartTree:
+    image: nginx
+    volumes:
+      - $HOME/.cache/StartTree/styles/colors.css:/usr/share/nginx/html/styles/colors.css # This needs to be changed depending on theme
+      - $HOME/.cache/StartTree/index.html:/usr/share/nginx/html/index.html
+      - $HOME/.cache/StartTree/styles/style.css:/usr/share/nginx/html/styles/style.css
+      - $HOME/.cache/StartTree/styles/Hack.ttf:/usr/share/nginx/html/styles/Hack.ttf
+    ports:
+    - "9876:80"
+    environment:
+    - NGINX_PORT=80
+    restart: unless-stopped

generate.py

@@ -56,17 +56,18 @@ def gen_col_headers(html_file, file_dict):
 
 def gen_columns(html_file, file_dict):
     for key in file_dict:
-        html_file.write("<div class=\"column\">\n")
+        if key.split("_")[0] == "tree":
-        html_file.write("  <div class=\"tree\">\n")
+            html_file.write("<div class=\"column\">\n")
-        html_file.write("    <h1>.</h1>\n")
+            html_file.write("  <div class=\"tree\">\n")
-        html_file.write("    <ul>\n")
+            html_file.write("    <h1>.</h1>\n")
+            html_file.write("    <ul>\n")
 
-        # generate the column headers
+            # generate the column headers
-        gen_col_headers(html_file, file_dict[key])
+            gen_col_headers(html_file, file_dict[key])
 
-        html_file.write("    </ul>\n")
+            html_file.write("    </ul>\n")
-        html_file.write("  </div>\n")
+            html_file.write("  </div>\n")
-        html_file.write("</div>\n")
+            html_file.write("</div>\n")
 
 
 def gen_html(file_dict):
@@ -98,13 +99,39 @@ def gen_html(file_dict):
 
     print("Done!")
 
+def gen_style(file_dict):
+    skeleton_style = open('./skeletons/style.css', 'r')
+    cache_style = open(cache_dir + '/styles/style.css', 'w')
 
-def gen_css(file_dict):
+    # find style attributes in file_dict
+    font_size = 20
+    theme = "void"
+    for key in file_dict:
+        if key == "font_size":
+            font_size = file_dict[key]
+        if key == "theme":
+            theme = file_dict[key]
+
+    if theme == "pywal":
+        theme = home + '/.cache/wal/colors.css'
+    else:
+        theme = '../themes/' + theme + '.css'
+
+    copyfile(theme, home + '/.cache/StartTree/styles/colors.css')
+
+    cache_style.write("@import url('./colors.css');\n")
+
+    lines = skeleton_style.readlines()
+    for line in lines:
+        if line == "/* font-size */\n":
+            cache_style.write("font-size: " + str(font_size) + "px;\n")
+        else:
+            cache_style.write(line)
 
 def main():
     file_dict = parse_yaml()
+    gen_style(file_dict)
     gen_html(file_dict)
-    gen_css(file_dict)
 
 if __name__ == '__main__':
     main()

init.py

@@ -21,11 +21,6 @@ config_path = home + '/.config/StartTree/config.yaml'
 # get cache path
 cache_dir = home + '/.cache/StartTree'
 
-def prettifyHTML(html):
-    soup = BeautifulSoup(html, 'html.parser')
-    prettyHTML = soup.prettify()
-    return prettyHTML
-
 def setup():
     # check if .config path exists
     if not os.path.isdir(home + '/.config'):
@@ -57,6 +52,9 @@ def setup():
         print("Creating '" + cache_dir + "'...")
         os.mkdir(cache_dir)
 
+        print("symlinking themes")
+        os.symlink(os.getcwd() + '/themes', home + '/.cache/StartTree/themes')
+
         print("Creating '" + cache_dir + "/styles'")
         os.mkdir(cache_dir + '/styles')
 

skeletons/style.css

@@ -1,4 +1,3 @@
-@import url('/home/paul/.cache/wal/colors.css');
 @font-face {
     font-family: "Roboto Mono";
     src: url("./Hack.ttf");
@@ -16,7 +15,7 @@
 }
 
 html {
-    font-size: 22px;
+/* font-size */
 }
 
 body {

themes/black-ice.css

@@ -0,0 +1,24 @@
+:root {
+    /* Special */
+    --background: #000000;
+    --foreground: #9a9c9f;
+    --cursor: #9a9c9f;
+
+    /* Colors */
+    --color0: #000000;
+    --color1: #04294d;
+    --color2: #2d2d2d;
+    --color3: #094c57;
+    --color4: #176485;
+    --color5: #585a5a;
+    --color6: #62909b;
+    --color7: #9a9c9f;
+    --color8: #36393f;
+    --color9: #04294d;
+    --color10: #2d2d2d;
+    --color11: #094c57;
+    --color12: #176485;
+    --color13: #585a5a;
+    --color14: #62909b;
+    --color15: #9a9c9f;
+}

themes/forest.css

@@ -0,0 +1,24 @@
+:root {
+    /* Special */
+    --background: #020303;
+    --foreground: #9da0a0;
+    --cursor: #9da0a0;
+
+    /* Colors */
+    --color0: #020303;
+    --color1: #2b3d30;
+    --color2: #424a55;
+    --color3: #405642;
+    --color4: #5b6a55;
+    --color5: #7f8d76;
+    --color6: #82908c;
+    --color7: #9da0a0;
+    --color8: #3b4242;
+    --color9: #2b3d30;
+    --color10: #424a55;
+    --color11: #405642;
+    --color12: #5b6a55;
+    --color13: #7f8d76;
+    --color14: #82908c;
+    --color15: #9da0a0;
+}