aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: e4f195bf5185b38c30be4b8a1fadf50e4e323045 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
MASU - minimalist dashboard

A web based grid of blocks (e.g., clocks, weather) with "real-time"
updates. Implemented in flask and vanilla js (trying to minimize bloat).
Features: simple, tweakable, fast.

setup:

    git clone <url>
    python -m venv .venv
    source .venv/bin/activate
    pip install -r requirements.txt
    python run.py

use:

    http://localhost:5000
    reload/tweak in header

hack:

    Each block is defined by:
    * html: front-end elements (modify: app/templates/index.html) (for now)
    * css: front-end design (modify: app/static/style.css)
    * js: front-end code (new file: app/static/block_name.js)
    * python: back-end code (app/routes/main.py, app/utils/block_name.py)

deploy:

    local: python app.py
    server: pip install gunicorn; gunicorn -w 4 app:app