martin/Freewheeling
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add more attributions, remove unnecessary package

Browse Source
This commit is contained in:
Martin Asprusten 2025-06-30 01:39:51 +02:00
parent e413687435
commit 8f0759fc63
4 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -6,8 +6,16 @@ To run, it requires a file named 'roads.dat', which contains road data for all o
This repository requires emscripten in order to build webassembly from the C++ code in the native folder. Before you can run npm run build or npm run build:emscripten, the emcc binary needs to be added to the PATH.
## To initialize
Install all required packages by running npm ci. Next, build the WebAssembly code needed for route calculations by running npm run build:emscripten.
## To run
First, run npm run build:emscripten, then run npx vite.
## To build
Run npm run build. This will first run the emscripten build, and then the typescript build. The resulting website ends up in the dist/ folder
Run npm run build. This will first run the emscripten build, and then the typescript build. The resulting website ends up in the dist/ folder.
## Attributions
This library uses the [leaflet](https://leafletjs.com/) library, which is licensed under the [2-clause BSD license](https://opensource.org/license/bsd-2-clause). It also uses the [leaflet-geoman-free](https://geoman.io/docs/leaflet/) and [proj4](http://proj4js.org/) libraries, which are licensed under the [MIT license.](https://opensource.org/license/mit). It also uses typescript definitions for [leaflet](https://www.npmjs.com/package/@types/leaflet) and [geojson](https://www.npmjs.com/package/@types/geojson), which are also licensed under the [MIT license](https://opensource.org/license/mit).
The SVG icons used for creating and deleting map areas are copied, unaltered, from [Font Awesome](https://fontawesome.com), and are licensed under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) license. The colored map markers are from the [leaflet-color-markers](https://github.com/pointhi/leaflet-color-markers) library, and are licensed under the [2-clause BSD license](https://opensource.org/license/bsd-2-clause).

19
index.html
View File

@ -87,6 +87,25 @@
at the top left of the map. After you've drawn the search area on the map, click the "Start search" button.
A table will show a running tally of the longest routes found.
</p>
<p>The source code for this web site can be found <a href="https://gitea.martinserver.no/martin/Freewheeling">here.</a></p>
<h2>Attributions:</h2>
<p>
This library uses the <a href="https://leafletjs.com/">leaflet</a> library, which is licensed under the
<a href="https://opensource.org/license/bsd-2-clause">2-clause BSD license</a>. It also uses
the <a href="https://geoman.io/docs/leaflet/">leaflet-geoman-free</a> and
<a href="http://proj4js.org/">proj4</a> libraries, which are licensed under the
<a href="https://opensource.org/license/mit">MIT license</a>.
</p>
<p>
The icons used for creating and deleting map areas are copied, unaltered, from
<a href="https://fontawesome.com">Font Awesome</a>, and are licensed under the
<a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International</a>
license. The colored map markers are from the
<a href="https://github.com/pointhi/leaflet-color-markers">leaflet-color-markers</a> library, and are
licensed under the <a href="https://opensource.org/license/bsd-2-clause">2-clause BSD license</a>.
</p>
</p>
</div>
</body>
</html>

9
package-lock.json generated
View File

@ -12,7 +12,6 @@
"@types/geojson": "^7946.0.16",
"@types/leaflet": "^1.9.19",
"leaflet": "^1.9.4",
"leaflet-extra-markers": "^1.2.2",
"proj4": "^2.19.4"
},
"devDependencies": {
@ -1103,14 +1102,6 @@
"integrity": "sha512-nxS1ynzJOmOlHp+iL3FyWqK89GtNL8U8rvlMOsQdTTssxZwCXh8N2NB3GDQOL+YR3XnWyZAxwQixURb+FA74PA==",
"license": "BSD-2-Clause"
},
"node_modules/leaflet-extra-markers": {
"version": "1.2.2",
"resolved": "https://registry.npmjs.org/leaflet-extra-markers/-/leaflet-extra-markers-1.2.2.tgz",
"integrity": "sha512-LQUicXhyOwq0wOFtEftJg9IzAGcQI+6mHgh3wsVntrid149BTqsEgh1UcxPPtzcL7xt8jXY0rssfz7DUZuQudg==",
"peerDependencies": {
"leaflet": ">= 0.5 < 2"
}
},
"node_modules/lodash": {
"version": "4.17.21",
"resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",

5
package.json
View File

@ -5,9 +5,9 @@
"type": "module",
"scripts": {
"dev": "vite",
"build:emscripten": "cd native && emcc -O3 -lembind -sEXPORT_ES6 -sASSERTIONS -sEXPORTED_RUNTIME_METHODS=FS -sALLOW_MEMORY_GROWTH -sMAXIMUM_MEMORY=4294967296 --emit-tsd route_search.d.ts -o route_search.js route_search.cpp",
"build:emscripten": "cd native && emcc -O3 -lembind -sEXPORT_ES6 -sASSERTIONS -sEXPORTED_RUNTIME_METHODS=FS -sALLOW_MEMORY_GROWTH -sMAXIMUM_MEMORY=4294967296 --emit-tsd route_search.d.ts -o route_search.js route_search.cpp",
"build:normal": "tsc && vite build",
"build": "npm run build:emscripten && npm run build:normal",
"build": "npm run build:emscripten && npm run build:normal",
"preview": "vite preview"
},
"devDependencies": {
@ -19,7 +19,6 @@
"@types/geojson": "^7946.0.16",
"@types/leaflet": "^1.9.19",
"leaflet": "^1.9.4",
"leaflet-extra-markers": "^1.2.2",
"proj4": "^2.19.4"
}
}