Open source hiking (but not only) app. Work in progress...

Go to file

Eric van der Vlist a6edcca740 Doc		2022-10-17 12:09:11 +02:00
public	Restarting from scratch	2022-10-17 10:08:00 +02:00
src	Adding typedoc in the loop	2022-10-17 12:04:25 +02:00
.gitignore	Removing the generateddoc from git.	2022-10-17 12:06:54 +02:00
README.md	Doc	2022-10-17 12:09:11 +02:00
capacitor.config.ts	Restarting from scratch	2022-10-17 10:08:00 +02:00
ionic.config.json	Initial commit	2022-08-31 14:35:20 +02:00
package-lock.json	Adding typedoc in the loop	2022-10-17 12:04:25 +02:00
package.json	Adding typedoc in the loop	2022-10-17 12:04:25 +02:00
tsconfig.json	Restarting from scratch	2022-10-17 10:08:00 +02:00
typedoc.json	Adding typedoc in the loop	2022-10-17 12:04:25 +02:00

README.md

Dyomedea

Hiking app.

Documentation

vdv@nuc:~/projects/tea/dyomedea/dyomedea$ npx typedoc 
./src/serviceWorkerRegistration.ts:21:0 - warning Config is referenced by serviceWorkerRegistration.register.register.config but not included in the documentation.

21    type Config = {

Documentation generated at ./doc
vdv@nuc:~/projects/tea/dyomedea/dyomedea$

Components

TBD

Data formats

There is a number of data formats more or less specific to geography and hiking, such as:

SVG is very generic and is used to draw 2D figures in HTML applications and doesn't care about geography.

KML, GeoJSON and OSM elements have been designed to represent generic geographical points and shapes.

GPX is more specific, having been designed to represent routes and tracks and its semantices are directly useable in our application.

The strucure of our components and indexes can therefore follow the GPX format.

OSM elements is interesting to extract information from the OSM DB, either by querying their API or by downloading portions of the database.

GeoJSON might be of interest as an intermediate format since a number of JS libraries have been developped to perform queries or draw GeoJSON data as SVG.

KML might be considered as an import format.

And SVG, of course will be used to render tracks and routes on a map since its elements are directly supported by React.

Notes to self

Patching node_modules

This can be done by updating their sources in the node_modules directory and using the patch-package npm CLI command (thanks stackoverflow) :

$npx patch-package localized-strings

However, it takes ages before ionic serve takes these modifications into account.