Skip to content

Commit 6a30f8f

Browse files
committed
clean (web): Add README and update ToDo
1 parent d50e8d4 commit 6a30f8f

File tree

3 files changed

+74
-2
lines changed

3 files changed

+74
-2
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ docs/BUILT/**
3737

3838
# Node.JS
3939
node_modules/
40+
# TODO This is ugly... how to better separate, to avoid?
41+
web/public/bundle.js
4042

4143
# Be
4244
.be/

web/README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!--
2+
SPDX-License-Identifier: Apache-2.0
3+
4+
Copyright 2025 The Enola <https://enola.dev> Authors
5+
6+
Licensed under the Apache License, Version 2.0 (the "License");
7+
you may not use this file except in compliance with the License.
8+
You may obtain a copy of the License at
9+
10+
https://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing, software
13+
distributed under the License is distributed on an "AS IS" BASIS,
14+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
See the License for the specific language governing permissions and
16+
limitations under the License.
17+
-->
18+
19+
# `enola/web` README
20+
21+
## Usage
22+
23+
1. `npm install` (TODO: Replace with Bazel...)
24+
25+
1. `npm run bundle`
26+
27+
1. `python3 -m http.server 7070`
28+
29+
1. Open <http://0.0.0.0:7070/public/index.html>
30+
31+
## NeXT
32+
33+
[ToDo](ToDo.md) has things to do for `web`/` (other TODO are elsewhere).

web/ToDo.md

+39-2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,43 @@
1616
limitations under the License.
1717
-->
1818

19-
# Enola **Web** #ToDo
19+
# Enola `enola/web` TODO
2020

21-
1.
21+
## Functional
22+
23+
* Use Enola Server `/gexf` instead of `arctic.gexf` (and delete that)
24+
* Let users drag nodes around
25+
* Click on node should open Enola details page on the right
26+
27+
## Visual
28+
29+
* Introduce a CSS so that controls are in a single row, with a nicer font
30+
* `<div id="container">` should fill entire available space
31+
* There shouldn't be any space around it
32+
33+
## Technical
34+
35+
### Clean
36+
37+
* Needing `web/public/bundle.js` in `.gitignore` is ugly; how to better separate, to avoid?
38+
39+
### Productivity
40+
41+
* How to auto rebuild & reload in browser on file change?
42+
43+
### TypeScript
44+
45+
* Convert `script.js` to `script.[m?]ts`
46+
47+
### Bazel
48+
49+
* Use https://github.com/aspect-build/rules_js
50+
51+
### Testing
52+
53+
* `npm run test` How to do web UI testing?
54+
* Make `bazel test //web` run web tests
55+
56+
### Performance
57+
58+
* #LATER

0 commit comments

Comments
 (0)