From 3ea316581cf146ea759d821d16a4c9a0685cdf30 Mon Sep 17 00:00:00 2001 From: Derek Stevens Date: Thu, 13 Jul 2023 00:17:53 -0600 Subject: [PATCH] fix readme and index footer --- README.md | 11 ++++++++--- static/index.html | 2 +- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 867429c..b771304 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The `status` panel is updated when the admin changes the table's status, and can The `token select` panel provides a list of every existing token at the table. Clicking the name of the token shows a to-scale preview at the top of the list (with a button to dismiss it), which is resized according to the zoom level of the map. The button to the right of each token's name can place the token on or remove it from the map. -Any user can move any token on the map. +Any user can move any token on the map by dragging it around. The map is pannable and zoomable as well. ### admin @@ -44,15 +44,20 @@ Creating or destroying tokens as well as changing the map causes updates to be s ## build, run, deploy +Requirements: + +- go +- docker + 1. Clone this repository and `cd` into it. 2. `go mod tidy` 3. `go build` 4. Simultaneously (from different terminals or services): - - from the `mongodb` folder, copy the `.env.example` file to `.env` and adjust it, then run `./run.sh build`. After initial run, the `build` argument is not needed + - from the `mongodb` folder, copy the `.env.example` file to `.env` and adjust it, then run `./run.sh build`. After initial run, the `build` argument is not needed; this runs the database in a docker container. Make note of your settings/credentials for the mongodb URI. - from the root folder, run `./felt` - a wizard asks for the mongodb URI (check mongo docs for this) the port, uploads folder, and max upload size - from the root folder, run `./felt invite` to get a registration token and register an admin account as explained above 5. When running behind a reverse proxy, you will need to make sure that the server can forward the `Upgrade: websocket` header. ## license -The `felt` code is released under the [MIT license](https://hacklab.nilfm.cc/felt/raw/main/LICENSE); [Leaflet](https://leafletjs.org), the slippy map library used in the frontend, is licensed under a [2-clause BSD license](https://hacklab.nilfm.cc/felt/raw/main/LEAFLETLICENSE). Basically do what you will but give credit. \ No newline at end of file +The `felt` code is released under the [MIT license](https://hacklab.nilfm.cc/felt/raw/main/LICENSE); [Leaflet](https://leafletjs.com), the slippy map library used in the frontend, is licensed under a [2-clause BSD license](https://hacklab.nilfm.cc/felt/raw/main/LEAFLET_LICENSE). Basically do what you will but give credit. \ No newline at end of file diff --git a/static/index.html b/static/index.html index 4ff4dd6..b4b4055 100644 --- a/static/index.html +++ b/static/index.html @@ -143,7 +143,7 @@ -
felt v0.1.0 (license) | built with leaflet (license)
+
felt v0.1.0 (license) | built with leaflet (license)