diff options
| author | Mitsuo Tokumori <[email protected]> | 2025-03-08 16:03:30 +0900 |
|---|---|---|
| committer | Mitsuo Tokumori <[email protected]> | 2025-03-08 16:03:30 +0900 |
| commit | 51163b167cce01af6101438e5e61145ad798f213 (patch) | |
| tree | 9c8e75266cedfb205db175b0b2bc41b49df75cea /README | |
| parent | d9af103b9a8aed86d6ac834f1240edfb2173ffa0 (diff) | |
| download | masu-51163b167cce01af6101438e5e61145ad798f213.tar.gz masu-51163b167cce01af6101438e5e61145ad798f213.tar.bz2 masu-51163b167cce01af6101438e5e61145ad798f213.zip | |
Restructure python code to be modular
The python code is now a package named app.
app/models: db models
app/routes: flask blueprints
app/static: css, js
app/templates: jinja html templates
Diffstat (limited to 'README')
| -rw-r--r-- | README | 25 |
1 files changed, 10 insertions, 15 deletions
@@ -1,34 +1,29 @@ MASU - minimalist dashboard -what: grid of blocks (clocks, weather, etc) w/ real-time updates - -how: flask + vanilla js, no bloat - -why: simple, tweakable, fast +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 flask requests - flask run + pip install -r requirements.txt + python run.py use: http://localhost:5000 reload/tweak in header -files: - - app.py: server - static/: css, js - templates/: html - hack: - add blocks: app.py + script.js - set intervals: script.js + 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: |
