Merge pull request 'Linting src in backend' (#40) from backend/linting-src into main

Reviewed-on: #40

.gitea/workflows/backend_run_lint.yaml

@@ -0,0 +1,34 @@
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - backend/**
+
+name: Run linting on the backend code
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: https://gitea.com/actions/checkout@v4
+
+    - name: Install dependencies
+      run: |
+        apt-get update && apt-get install -y python3 python3-pip
+        pip install pipenv        
+
+    - name: Install packages
+      run: |
+        ls -la
+        # only install dev-packages
+        pipenv install --categories=dev-packages
+        pipenv run pip freeze        
+
+      working-directory: backend
+
+    - name: Run linter
+      run: pipenv run pylint src
+      working-directory: backend

.gitea/workflows/backend_run_test.yaml

@@ -0,0 +1,40 @@
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - backend/**
+
+name: Run testing on the backend code
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: https://gitea.com/actions/checkout@v4
+
+    - name: Install dependencies
+      run: |
+        apt-get update && apt-get install -y python3 python3-pip
+        pip install pipenv        
+
+    - name: Install packages
+      run: |
+        ls -la
+        # install all packages, including dev-packages
+        pipenv install --dev
+        pipenv run pip freeze        
+      working-directory: backend
+
+    - name: Run Tests
+      run: pipenv run pytest src --html=report.html --self-contained-html
+      working-directory: backend
+
+    - name: Upload HTML report
+      if: always()
+      uses: https://gitea.com/actions/upload-artifact@v3
+      with:
+        name: pytest-html-report
+        path: backend/report.html

.vscode/launch.json

@@ -14,9 +14,9 @@
                 "DEBUG": "true"
             },
             "args": [
-                "--app-dir",
-                "src",
-                "main:app",
+                // "--app-dir",
+                // "src",
+                "src.main:app",
                 "--reload",
             ],
             "jinja": true,

backend/.pylintrc

@@ -0,0 +1,648 @@
+[MAIN]
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+# Clear in-memory caches upon conclusion of linting. Useful if running pylint
+# in a server-like mode.
+clear-cache-post-run=no
+
+# Load and enable all available extensions. Use --list-extensions to see a list
+# all available extensions.
+#enable-all-extensions=
+
+# In error mode, messages with a category besides ERROR or FATAL are
+# suppressed, and no reports are done by default. Error mode is compatible with
+# disabling specific errors.
+#errors-only=
+
+# Always return a 0 (non-error) status code, even if lint errors are found.
+# This is primarily useful in continuous integration scripts.
+#exit-zero=
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code.
+extension-pkg-allow-list=
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
+# for backward compatibility.)
+extension-pkg-whitelist=
+
+# Return non-zero exit code if any of these messages/categories are detected,
+# even if score is above --fail-under value. Syntax same as enable. Messages
+# specified are enabled, while categories only check already-enabled messages.
+fail-on=
+
+# Specify a score threshold under which the program will exit with error.
+fail-under=10
+
+# Interpret the stdin as a python script, whose filename needs to be passed as
+# the module_or_package argument.
+#from-stdin=
+
+# Files or directories to be skipped. They should be base names, not paths.
+ignore=CVS
+
+# Add files or directories matching the regular expressions patterns to the
+# ignore-list. The regex matches against paths and can be in Posix or Windows
+# format. Because '\\' represents the directory delimiter on Windows systems,
+# it can't be used as an escape character.
+ignore-paths=
+
+# Files or directories matching the regular expression patterns are skipped.
+# The regex matches against base names, not paths. The default value ignores
+# Emacs file locks
+ignore-patterns=^\.#
+
+# List of module names for which member attributes should not be checked and
+# will not be imported (useful for modules/projects where namespaces are
+# manipulated during runtime and thus existing member attributes cannot be
+# deduced by static analysis). It supports qualified module names, as well as
+# Unix pattern matching.
+ignored-modules=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use, and will cap the count on Windows to
+# avoid hangs.
+jobs=1
+
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
+
+# List of plugins (as comma separated values of python module names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# Resolve imports to .pyi stubs if available. May reduce no-member messages and
+# increase not-an-iterable messages.
+prefer-stubs=no
+
+# Minimum Python version to use for version dependent checks. Will default to
+# the version used to run pylint.
+py-version=3.12
+
+# Discover python modules and packages in the file system subtree.
+recursive=no
+
+# Add paths to the list of the source roots. Supports globbing patterns. The
+# source root is an absolute path or a path relative to the current working
+# directory used to determine a package namespace for modules located under the
+# source root.
+source-roots=
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages.
+suggestion-mode=yes
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+# In verbose mode, extra non-checker-related info will be displayed.
+#verbose=
+
+
+[BASIC]
+
+# Naming style matching correct argument names.
+argument-naming-style=snake_case
+
+# Regular expression matching correct argument names. Overrides argument-
+# naming-style. If left empty, argument names will be checked with the set
+# naming style.
+#argument-rgx=
+
+# Naming style matching correct attribute names.
+attr-naming-style=snake_case
+
+# Regular expression matching correct attribute names. Overrides attr-naming-
+# style. If left empty, attribute names will be checked with the set naming
+# style.
+#attr-rgx=
+
+# Bad variable names which should always be refused, separated by a comma.
+bad-names=foo,
+          bar,
+          baz,
+          toto,
+          tutu,
+          tata
+
+# Bad variable names regexes, separated by a comma. If names match any regex,
+# they will always be refused
+bad-names-rgxs=
+
+# Naming style matching correct class attribute names.
+class-attribute-naming-style=any
+
+# Regular expression matching correct class attribute names. Overrides class-
+# attribute-naming-style. If left empty, class attribute names will be checked
+# with the set naming style.
+#class-attribute-rgx=
+
+# Naming style matching correct class constant names.
+class-const-naming-style=UPPER_CASE
+
+# Regular expression matching correct class constant names. Overrides class-
+# const-naming-style. If left empty, class constant names will be checked with
+# the set naming style.
+#class-const-rgx=
+
+# Naming style matching correct class names.
+class-naming-style=PascalCase
+
+# Regular expression matching correct class names. Overrides class-naming-
+# style. If left empty, class names will be checked with the set naming style.
+#class-rgx=
+
+# Naming style matching correct constant names.
+const-naming-style=UPPER_CASE
+
+# Regular expression matching correct constant names. Overrides const-naming-
+# style. If left empty, constant names will be checked with the set naming
+# style.
+#const-rgx=
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+# Naming style matching correct function names.
+function-naming-style=snake_case
+
+# Regular expression matching correct function names. Overrides function-
+# naming-style. If left empty, function names will be checked with the set
+# naming style.
+#function-rgx=
+
+# Good variable names which should always be accepted, separated by a comma.
+good-names=i,
+           j,
+           k,
+           ex,
+           Run,
+           _
+
+# Good variable names regexes, separated by a comma. If names match any regex,
+# they will always be accepted
+good-names-rgxs=
+
+# Include a hint for the correct naming format with invalid-name.
+include-naming-hint=no
+
+# Naming style matching correct inline iteration names.
+inlinevar-naming-style=any
+
+# Regular expression matching correct inline iteration names. Overrides
+# inlinevar-naming-style. If left empty, inline iteration names will be checked
+# with the set naming style.
+#inlinevar-rgx=
+
+# Naming style matching correct method names.
+method-naming-style=snake_case
+
+# Regular expression matching correct method names. Overrides method-naming-
+# style. If left empty, method names will be checked with the set naming style.
+#method-rgx=
+
+# Naming style matching correct module names.
+module-naming-style=snake_case
+
+# Regular expression matching correct module names. Overrides module-naming-
+# style. If left empty, module names will be checked with the set naming style.
+#module-rgx=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+# These decorators are taken in consideration only for invalid-name.
+property-classes=abc.abstractproperty
+
+# Regular expression matching correct type alias names. If left empty, type
+# alias names will be checked with the set naming style.
+#typealias-rgx=
+
+# Regular expression matching correct type variable names. If left empty, type
+# variable names will be checked with the set naming style.
+#typevar-rgx=
+
+# Naming style matching correct variable names.
+variable-naming-style=snake_case
+
+# Regular expression matching correct variable names. Overrides variable-
+# naming-style. If left empty, variable names will be checked with the set
+# naming style.
+#variable-rgx=
+
+
+[CLASSES]
+
+# Warn about protected attribute access inside special methods
+check-protected-access-in-special-methods=no
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+                      __new__,
+                      setUp,
+                      asyncSetUp,
+                      __post_init__
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=mcs
+
+
+[DESIGN]
+
+# List of regular expressions of class ancestor names to ignore when counting
+# public methods (see R0903)
+exclude-too-few-public-methods=
+
+# List of qualified class names to ignore when counting class parents (see
+# R0901)
+ignored-parents=
+
+# Maximum number of arguments for function / method.
+max-args=5
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Maximum number of boolean expressions in an if statement (see R0916).
+max-bool-expr=5
+
+# Maximum number of branch for function / method body.
+max-branches=12
+
+# Maximum number of locals for function / method body.
+max-locals=15
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of positional arguments for function / method.
+max-positional-arguments=5
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+# Maximum number of return / yield for function / method body.
+max-returns=6
+
+# Maximum number of statements in function / method body.
+max-statements=50
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when caught.
+overgeneral-exceptions=builtins.BaseException,builtins.Exception
+
+
+[FORMAT]
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+
+# Number of spaces of indent required inside a hanging or continued line.
+indent-after-paren=4
+
+# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+# Maximum number of characters on a single line.
+max-line-length=105
+
+# Maximum number of lines in a module.
+max-module-lines=1000
+
+# Allow the body of a class to be on the same line as the declaration if body
+# contains single statement.
+single-line-class-stmt=no
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=no
+
+
+[IMPORTS]
+
+# List of modules that can be imported at any level, not just the top level
+# one.
+allow-any-import-level=
+
+# Allow explicit reexports by alias from a package __init__.
+allow-reexport-from-package=no
+
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=no
+
+# Deprecated modules which should not be used, separated by a comma.
+deprecated-modules=
+
+# Output a graph (.gv or any supported image format) of external dependencies
+# to the given file (report RP0402 must not be disabled).
+ext-import-graph=
+
+# Output a graph (.gv or any supported image format) of all (i.e. internal and
+# external) dependencies to the given file (report RP0402 must not be
+# disabled).
+import-graph=
+
+# Output a graph (.gv or any supported image format) of internal dependencies
+# to the given file (report RP0402 must not be disabled).
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant
+
+# Couples of modules and preferred modules, separated by a comma.
+preferred-modules=
+
+
+[LOGGING]
+
+# The type of string formatting that logging methods do. `old` means using %
+# formatting, `new` is for `{}` formatting.
+logging-format-style=old
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format.
+logging-modules=logging
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
+# UNDEFINED.
+confidence=HIGH,
+           CONTROL_FLOW,
+           INFERENCE,
+           INFERENCE_FAILURE,
+           UNDEFINED
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once). You can also use "--disable=all" to
+# disable everything first and then re-enable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+disable=raw-checker-failed,
+        bad-inline-option,
+        locally-disabled,
+        file-ignored,
+        suppressed-message,
+        useless-suppression,
+        deprecated-pragma,
+        use-symbolic-message-instead,
+        use-implicit-booleaness-not-comparison-to-string,
+        use-implicit-booleaness-not-comparison-to-zero,
+        import-error
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once). See also the "--disable" option for examples.
+enable=
+
+
+[METHOD_ARGS]
+
+# List of qualified names (i.e., library.method) which require a timeout
+# parameter e.g. 'requests.api.get,requests.api.post'
+timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,
+      XXX,
+      TODO
+
+# Regular expression of note tags to take in consideration.
+notes-rgx=
+
+
+[REFACTORING]
+
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=5
+
+# Complete name of functions that never returns. When checking for
+# inconsistent-return-statements if a never returning function is called then
+# it will be considered as an explicit return statement and no message will be
+# printed.
+never-returning-functions=sys.exit,argparse.parse_error
+
+# Let 'consider-using-join' be raised when the separator to join on would be
+# non-empty (resulting in expected fixes of the type: ``"- " + " -
+# ".join(items)``)
+suggest-join-with-non-empty-separator=yes
+
+
+[REPORTS]
+
+# Python expression which should return a score less than or equal to 10. You
+# have access to the variables 'fatal', 'error', 'warning', 'refactor',
+# 'convention', and 'info' which contain the number of messages in each
+# category, as well as 'statement' which is the total number of statements
+# analyzed. This score is used by the global evaluation report (RP0004).
+evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details.
+msg-template=
+
+# Set the output format. Available formats are: text, parseable, colorized,
+# json2 (improved json format), json (old json format) and msvs (visual
+# studio). You can also give a reporter class, e.g.
+# mypackage.mymodule.MyReporterClass.
+#output-format=
+
+# Tells whether to display a full report or only the messages.
+reports=no
+
+# Activate the evaluation score.
+score=yes
+
+
+[SIMILARITIES]
+
+# Comments are removed from the similarity computation
+ignore-comments=yes
+
+# Docstrings are removed from the similarity computation
+ignore-docstrings=yes
+
+# Imports are removed from the similarity computation
+ignore-imports=yes
+
+# Signatures are removed from the similarity computation
+ignore-signatures=yes
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+
+[SPELLING]
+
+# Limits count of emitted suggestions for spelling mistakes.
+max-spelling-suggestions=4
+
+# Spelling dictionary name. No available dictionaries : You need to install
+# both the python package and the system dependency for enchant to work.
+spelling-dict=
+
+# List of comma separated words that should be considered directives if they
+# appear at the beginning of a comment and should not be checked.
+spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains the private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to the private dictionary (see the
+# --spelling-private-dict-file option) instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[STRING]
+
+# This flag controls whether inconsistent-quotes generates a warning when the
+# character used as a quote delimiter is used inconsistently within a module.
+check-quote-consistency=no
+
+# This flag controls whether the implicit-str-concat should generate a warning
+# on implicit string concatenation in sequences defined over several lines.
+check-str-concat-over-line-jumps=no
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+# Tells whether to warn about missing members when the owner of the attribute
+# is inferred to be None.
+ignore-none=yes
+
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
+
+# List of symbolic message names to ignore for Mixin members.
+ignored-checks-for-mixins=no-member,
+                          not-async-context-manager,
+                          not-context-manager,
+                          attribute-defined-outside-init
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace
+
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
+
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
+
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
+
+# Regex pattern to define which classes are considered mixins.
+mixin-class-rgx=.*[Mm]ixin
+
+# List of decorators that change the signature of a decorated function.
+signature-mutators=
+
+
+[VARIABLES]
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid defining new builtins when possible.
+additional-builtins=
+
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of names allowed to shadow builtins
+allowed-redefined-builtins=
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,
+          _cb
+
+# A regular expression matching the name of dummy variables (i.e. expected to
+# not be used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored.
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io

backend/Pipfile

@@ -4,6 +4,14 @@ verify_ssl = true
 name = "pypi"
 
 [dev-packages]
+pylint = "*"
+pytest = "*"
+tomli = "*"
+httpx = "*"
+exceptiongroup = "*"
+pytest-html = "*"
+typing-extensions = "*"
+dill = "*"
 
 [packages]
 numpy = "*"

backend/conftest.py

@@ -0,0 +1,47 @@
+import pytest
+
+pytest_plugins = ["pytest_html"]
+
+def pytest_html_report_title(report):
+    """modifying the title  of html report"""
+    report.title = "Backend Testing Report"
+
+def pytest_html_results_table_header(cells):
+    cells.insert(2, "<th>Detailed trip</th>")
+    cells.insert(3, "<th>Trip Duration</th>")
+    cells.insert(4, "<th>Target Duration</th>")
+    cells[5] = "<th>Execution time</th>"            # rename the column containing execution times to avoid confusion
+
+
+def pytest_html_results_table_row(report, cells):
+    trip_details = getattr(report, "trip_details", "N/A")  # Default to "N/A" if no trip data
+    trip_duration = getattr(report, "trip_duration", "N/A")  # Default to "N/A" if no trip data
+    target_duration = getattr(report, "target_duration", "N/A")  # Default to "N/A" if no trip data
+    cells.insert(2, f"<td>{trip_details}</td>")
+    cells.insert(3, f"<td>{trip_duration}</td>")
+    cells.insert(4, f"<td>{target_duration}</td>")
+
+
+@pytest.hookimpl(hookwrapper=True)
+def pytest_runtest_makereport(item, call):
+    outcome = yield
+    report = outcome.get_result()
+    report.description = str(item.function.__doc__)
+
+    # Attach trip_details if it exists
+    if hasattr(item, "trip_details"):
+        report.trip_details = " - ".join(item.trip_details)  # Convert list to string
+    else:
+        report.trip_details = "N/A"  # Default if trip_string is not set
+
+    # Attach trip_duration if it exists
+    if hasattr(item, "trip_duration"):
+        report.trip_duration = item.trip_duration + " min"  
+    else:
+        report.trip_duration = "N/A"  # Default if duration is not set
+
+    # Attach target_duration if it exists
+    if hasattr(item, "target_duration"):
+        report.target_duration = item.target_duration + " min"  
+    else:
+        report.target_duration = "N/A"  # Default if duration is not set

backend/src/constants.py

@@ -1,6 +1,9 @@
-import logging.config
-from pathlib import Path
+"""Module allowing to access the parameters of route generation"""
+
+import logging
 import os
+from pathlib import Path
+
 
 LOCATION_PREFIX = Path('src')
 PARAMETERS_DIR = LOCATION_PREFIX / 'parameters'
@@ -9,12 +12,10 @@ LANDMARK_PARAMETERS_PATH = PARAMETERS_DIR / 'landmark_parameters.yaml'
 OPTIMIZER_PARAMETERS_PATH = PARAMETERS_DIR / 'optimizer_parameters.yaml'
 
 
-
 cache_dir_string = os.getenv('OSM_CACHE_DIR', './cache')
 OSM_CACHE_DIR = Path(cache_dir_string)
 
 
-import logging
 # if we are in a debug session, set verbose and rich logging
 if os.getenv('DEBUG', "false") == "true":
     from rich.logging import RichHandler

backend/src/main.py

@@ -1,14 +1,16 @@
-import logging
-from fastapi import FastAPI, Query, Body, HTTPException
+"""Main app for backend api"""
 
-from structs.landmark import Landmark
-from structs.preferences import Preferences
-from structs.linked_landmarks import LinkedLandmarks
-from structs.trip import Trip
-from utils.landmarks_manager import LandmarkManager
-from utils.optimizer import Optimizer
-from utils.refiner import Refiner
-from persistence import client as cache_client
+import logging
+from fastapi import FastAPI, HTTPException
+
+from .structs.landmark import Landmark
+from .structs.preferences import Preferences
+from .structs.linked_landmarks import LinkedLandmarks
+from .structs.trip import Trip
+from .utils.landmarks_manager import LandmarkManager
+from .utils.optimizer import Optimizer
+from .utils.refiner import Refiner
+from .persistence import client as cache_client
 
 
 logger = logging.getLogger(__name__)
@@ -20,26 +22,54 @@ refiner = Refiner(optimizer=optimizer)
 
 
 @app.post("/trip/new")
-def new_trip(preferences: Preferences, start: tuple[float, float], end: tuple[float, float] | None = None) -> Trip:
-    '''
+def new_trip(preferences: Preferences,
+             start: tuple[float, float],
+             end: tuple[float, float] | None = None) -> Trip:
+    """
     Main function to call the optimizer.
-    :param preferences: the preferences specified by the user as the post body
-    :param start: the coordinates of the starting point as a tuple of floats (as url query parameters)
-    :param end: the coordinates of the finishing point as a tuple of floats (as url query parameters)
-    :return: the uuid of the first landmark in the optimized route
-    '''
+
+    Args:
+        preferences : the preferences specified by the user as the post body
+        start       : the coordinates of the starting point
+        end         : the coordinates of the finishing point
+    Returns: 
+        (uuid) : The uuid of the first landmark in the optimized route
+    """
     if preferences is None:
-        raise HTTPException(status_code=406, detail="Preferences not provided")
-    if preferences.shopping.score == 0 and preferences.sightseeing.score == 0 and preferences.nature.score == 0:
-        raise HTTPException(status_code=406, detail="All preferences are 0.")
+        raise HTTPException(status_code=406,
+                            detail="Preferences not provided or incomplete.")
+    if (preferences.shopping.score == 0 and
+        preferences.sightseeing.score == 0 and
+        preferences.nature.score == 0) :
+        raise HTTPException(status_code=406,
+                            detail="All preferences are 0.")
     if start is None:
-        raise HTTPException(status_code=406, detail="Start coordinates not provided")
+        raise HTTPException(status_code=406,
+                            detail="Start coordinates not provided")
+    if not (-90 <= start[0] <= 90 or -180 <= start[1] <= 180):
+        raise HTTPException(status_code=423,
+                            detail="Start coordinates not in range")
     if end is None:
         end = start
         logger.info("No end coordinates provided. Using start=end.")
 
-    start_landmark = Landmark(name='start', type='start', location=(start[0], start[1]), osm_type='start', osm_id=0, attractiveness=0, must_do=True, n_tags = 0)
-    end_landmark = Landmark(name='finish', type='finish', location=(end[0], end[1]), osm_type='end', osm_id=0, attractiveness=0, must_do=True, n_tags = 0)
+    start_landmark = Landmark(name='start',
+                              type='start',
+                              location=(start[0], start[1]),
+                              osm_type='start',
+                              osm_id=0,
+                              attractiveness=0,
+                              must_do=True,
+                              n_tags = 0)
+    
+    end_landmark = Landmark(name='finish',
+                            type='finish',
+                            location=(end[0], end[1]),
+                            osm_type='end',
+                            osm_id=0,
+                            attractiveness=0,
+                            must_do=True,
+                            n_tags = 0)
 
     # Generate the landmarks from the start location
     landmarks, landmarks_short = manager.generate_landmarks_list(
@@ -50,20 +80,22 @@ def new_trip(preferences: Preferences, start: tuple[float, float], end: tuple[fl
     # insert start and finish to the landmarks list
     landmarks_short.insert(0, start_landmark)
     landmarks_short.append(end_landmark)
-    
+
     # First stage optimization
     try:
         base_tour = optimizer.solve_optimization(preferences.max_time_minute, landmarks_short)
-    except ArithmeticError:
-        raise HTTPException(status_code=500, detail="No solution found")
-    except TimeoutError:
-        raise HTTPException(status_code=500, detail="Optimzation took too long")
-    
+    except ArithmeticError as exc:
+        raise HTTPException(status_code=500, detail="No solution found") from exc
+    except TimeoutError as exc:
+        raise HTTPException(status_code=500, detail="Optimzation took too long") from exc
+
     # Second stage optimization
-    refined_tour = refiner.refine_optimization(landmarks, base_tour, preferences.max_time_minute, preferences.detour_tolerance_minute)
+    refined_tour = refiner.refine_optimization(landmarks, base_tour,
+                                               preferences.max_time_minute,
+                                               preferences.detour_tolerance_minute)
 
     linked_tour = LinkedLandmarks(refined_tour)
-    # upon creation of the trip, persistence of both the trip and its landmarks is ensured
+    # upon creation of the trip, persistence of both the trip and its landmarks is ensured.
     trip = Trip.from_linked_landmarks(linked_tour, cache_client)
     return trip
 
@@ -71,17 +103,36 @@ def new_trip(preferences: Preferences, start: tuple[float, float], end: tuple[fl
 #### For already existing trips/landmarks
 @app.get("/trip/{trip_uuid}")
 def get_trip(trip_uuid: str) -> Trip:
+    """
+    Look-up the cache for a trip that has been previously generated using its identifier.
+
+    Args:
+        trip_uuid (str) : unique identifier for a trip.
+
+    Returns:
+        (Trip)          : the corresponding trip.
+    """
     try:
         trip = cache_client.get(f"trip_{trip_uuid}")
         return trip
-    except KeyError:
-        raise HTTPException(status_code=404, detail="Trip not found")
+    except KeyError as exc:
+        raise HTTPException(status_code=404, detail="Trip not found") from exc
 
 
 @app.get("/landmark/{landmark_uuid}")
 def get_landmark(landmark_uuid: str) -> Landmark:
+    """
+    Returns a Landmark from its unique identifier.
+
+    Args:
+        landmark_uuid (str) : unique identifier for a Landmark.
+
+    Returns:
+        (Landmark)          : the corresponding Landmark.
+    """
     try:
         landmark = cache_client.get(f"landmark_{landmark_uuid}")
         return landmark
-    except KeyError:
-        raise HTTPException(status_code=404, detail="Landmark not found")
+    except KeyError as exc:
+        raise HTTPException(status_code=404,
+                            detail="Landmark not found") from exc

backend/src/parameters/amenity_selectors.yaml

@@ -71,8 +71,10 @@ sightseeing:
     - castle
     - museum
 
-
-
+museums:
+  tourism:
+    - museum
+    - aquarium
 
 # to be used later on
 restauration:

backend/src/parameters/landmark_parameters.yaml

@@ -1,11 +1,12 @@
 city_bbox_side: 7500 #m
 radius_close_to: 50
-church_coeff: 0.5
+church_coeff: 0.9
 nature_coeff: 1.25
 overall_coeff: 10
 tag_exponent: 1.15
 image_bonus: 10
 viewpoint_bonus: 15
-wikipedia_bonus: 6
+wikipedia_bonus: 4
+name_bonus: 3
 N_important: 40
 pay_bonus: -1

backend/src/parameters/optimizer_parameters.yaml

@@ -3,4 +3,4 @@ detour_corridor_width: 300
 average_walking_speed: 4.8
 max_landmarks: 10
 max_landmarks_refiner: 30
-overshoot: 1.8
+overshoot: 1.1

backend/src/persistence.py

@@ -1,28 +1,74 @@
-from pymemcache.client.base import Client
-from pymemcache import serde
+"""Module used for handling cache"""
 
-import constants
+from pymemcache.client.base import Client
+
+from .constants import MEMCACHED_HOST_PATH
 
 
 class DummyClient:
+    """
+    A dummy in-memory client that mimics the behavior of a memcached client.
+
+    This class is designed to simulate the behavior of the `pymemcache.Client`
+    for testing or development purposes. It stores data in a Python dictionary
+    and provides methods to set, get, and update key-value pairs.
+
+    Attributes:
+        _data (dict): A dictionary that holds the key-value pairs.
+
+    Methods:
+        set(key, value, **kwargs):
+            Stores the given key-value pair in the internal dictionary.
+
+        set_many(data, **kwargs):
+            Updates the internal dictionary with multiple key-value pairs.
+
+        get(key, **kwargs):
+            Retrieves the value associated with the given key from the internal
+            dictionary.
+    """
     _data = {}
-    def set(self, key, value, **kwargs):
+    def set(self, key, value, **kwargs):    # pylint: disable=unused-argument
+        """
+        Store a key-value pair in the internal dictionary.
+
+        Args:
+            key: The key for the item to be stored.
+            value: The value to be stored under the given key.
+            **kwargs: Additional keyword arguments (unused).
+        """
         self._data[key] = value
 
-    def set_many(self, data, **kwargs):
+    def set_many(self, data, **kwargs): # pylint: disable=unused-argument
+        """
+        Update the internal dictionary with multiple key-value pairs.
+
+        Args:
+            data: A dictionary containing key-value pairs to be added.
+            **kwargs: Additional keyword arguments (unused).
+        """
         self._data.update(data)
 
-    def get(self, key, **kwargs):
+    def get(self, key, **kwargs):   # pylint: disable=unused-argument
+        """
+        Retrieve the value associated with the given key.
+
+        Args:
+            key: The key for the item to be retrieved.
+            **kwargs: Additional keyword arguments (unused).
+
+        Returns:
+            The value associated with the given key if it exists.
+        """
         return self._data[key]
 
 
-if constants.MEMCACHED_HOST_PATH is None:
+if MEMCACHED_HOST_PATH is None:
     client = DummyClient()
 else:
     client = Client(
-        constants.MEMCACHED_HOST_PATH,
-        timeout = 1,
-        allow_unicode_keys = True,
-        encoding = 'utf-8',
-        serde = serde.pickle_serde
+        MEMCACHED_HOST_PATH,
+        timeout=1,
+        allow_unicode_keys=True,
+        encoding='utf-8'
     )

backend/src/structs/landmark.py

@@ -1,10 +1,41 @@
+"""Definition of the Landmark class to handle visitable objects across the world."""
+
 from typing import Optional, Literal
+from uuid import uuid4
 from pydantic import BaseModel, Field
 
-from uuid import uuid4
 
 # Output to frontend
 class Landmark(BaseModel) :
+    """
+    A class representing a landmark or point of interest (POI) in the context of a trip.
+
+    The Landmark class is used to model visitable locations, such as tourist attractions,
+    natural sites, shopping locations, and start/end points in travel itineraries. It
+    holds information about the landmark's attributes and supports comparisons and
+    calculations, such as distance between landmarks.
+
+    Attributes:
+        name (str): The name of the landmark.
+        type (Literal): The type of the landmark, which can be one of ['sightseeing', 'nature', 
+            'shopping', 'start', 'finish'].
+        location (tuple): A tuple representing the (latitude, longitude) of the landmark.
+        osm_type (str): The OpenStreetMap (OSM) type of the landmark.
+        osm_id (int): The OpenStreetMap (OSM) ID of the landmark.
+        attractiveness (int): A score representing the attractiveness of the landmark.
+        n_tags (int): The number of tags associated with the landmark.
+        image_url (Optional[str]): A URL to an image of the landmark.
+        website_url (Optional[str]): A URL to the landmark's official website.
+        description (Optional[str]): A text description of the landmark.
+        duration (Optional[int]): The estimated time to visit the landmark (in minutes).
+        name_en (Optional[str]): The English name of the landmark.
+        uuid (str): A unique identifier for the landmark, generated by default using uuid4.
+        must_do (Optional[bool]): Whether the landmark is a "must-do" attraction.
+        must_avoid (Optional[bool]): Whether the landmark should be avoided.
+        is_secondary (Optional[bool]): Whether the landmark is secondary or less important.
+        time_to_reach_next (Optional[int]): Estimated time (in minutes) to reach the next landmark.
+        next_uuid (Optional[str]): UUID of the next landmark in sequence (if applicable).
+    """
 
     # Properties of the landmark
     name : str
@@ -26,27 +57,63 @@ class Landmark(BaseModel) :
     # Additional properties depending on specific tour
     must_do : Optional[bool] = False
     must_avoid : Optional[bool] = False
-    is_secondary : Optional[bool] = False                       # TODO future   
+    is_secondary : Optional[bool] = False
 
     time_to_reach_next : Optional[int] = 0
     next_uuid : Optional[str] = None
 
     def __str__(self) -> str:
-        time_to_next_str = f", time_to_next={self.time_to_reach_next}" if self.time_to_reach_next else ""
-        is_secondary_str = f", secondary" if self.is_secondary else ""
+        """
+        String representation of the Landmark object.
+
+        Returns:
+            str: A formatted string with the landmark's type, name, location, attractiveness score,
+            time to the next landmark (if available), and whether the landmark is secondary.
+        """
+        t_to_next_str = f", time_to_next={self.time_to_reach_next}" if self.time_to_reach_next else ""
+        is_secondary_str = ", secondary" if self.is_secondary else ""
         type_str = '(' + self.type + ')'
-        if self.type in ["start", "finish", "nature", "shopping"] : type_str += '\t '
-        return f'Landmark{type_str}: [{self.name} @{self.location}, score={self.attractiveness}{time_to_next_str}{is_secondary_str}]'
+        if self.type in ["start", "finish", "nature", "shopping"] :
+            type_str += '\t '
+
+        return (f'Landmark{type_str}: [{self.name} @{self.location}, '
+                f'score={self.attractiveness}{t_to_next_str}{is_secondary_str}]')
 
     def distance(self, value: 'Landmark') -> float:
+        """
+        Calculates the squared distance between this landmark and another.
+
+        Args:
+            value (Landmark): Another Landmark object to calculate the distance to.
+
+        Returns:
+            float: The squared Euclidean distance between the two landmarks.
+        """
         return (self.location[0] - value.location[0])**2 + (self.location[1] - value.location[1])**2
 
     def __hash__(self) -> int:
+        """
+        Generates a hash for the Landmark based on its name.
+
+        Returns:
+            int: The hash of the landmark.
+        """
         return hash(self.name)
 
     def __eq__(self, value: 'Landmark') -> bool:
+        """
+        Checks equality between two Landmark objects based on UUID, OSM ID, and name.
+
+        Args:
+            value (Landmark): Another Landmark object to compare.
+
+        Returns:
+            bool: True if the landmarks are equal, False otherwise.
+        """
         # eq and hash must be consistent
         # in particular, if two objects are equal, their hash must be equal
         # uuid and osm_id are just shortcuts to avoid comparing all the properties
         # if they are equal, we know that the name is also equal and in turn the hash is equal
-        return self.uuid == value.uuid or self.osm_id == value.osm_id or (self.name == value.name and self.distance(value) < 0.001)
+        return (self.uuid == value.uuid or
+                self.osm_id == value.osm_id or
+                (self.name == value.name and self.distance(value) < 0.001))

backend/src/structs/linked_landmarks.py

@@ -1,21 +1,30 @@
+"""Linked and ordered list of Landmarks that represents the visiting order."""
+
 from .landmark import Landmark
-from utils.get_time_separation import get_time
+from ..utils.get_time_separation import get_time
 
 class LinkedLandmarks:
     """
     A list of landmarks that are linked together, e.g. in a route.
-    Each landmark serves as a node in the linked list, but since we expect these to be consumed through the rest API, a pythonic reference to the next landmark is not well suited. Instead we use the uuid of the next landmark to reference the next landmark in the list. This is not very efficient, but appropriate for the expected use case ("short" trips with onyl few landmarks).
+    Each landmark serves as a node in the linked list, but since we expect
+    these to be consumed through the rest API, a pythonic reference to the next
+    landmark is not well suited. Instead we use the uuid of the next landmark
+    to reference the next landmark in the list. This is not very efficient,
+    but appropriate for the expected use case
+    ("short" trips with onyl few landmarks).
     """
-    
+
     _landmarks = list[Landmark]
     total_time: int = 0
 
     def __init__(self, data: list[Landmark] = None) -> None:
         """
-        Initialize a new LinkedLandmarks object. This expects an ORDERED list of landmarks, where the first landmark is the starting point and the last landmark is the end point.
-        
+        Initialize a new LinkedLandmarks object. This expects an ORDERED list of landmarks,
+        where the first landmark is the starting point and the last landmark is the end point.
+
         Args:
-            data (list[Landmark], optional): The list of landmarks that are linked together. Defaults to None.
+            data (list[Landmark], optional):    The list of landmarks that are linked together.
+                                                Defaults to None.
         """
         self._landmarks = data if data else []
         self._link_landmarks()
@@ -23,7 +32,8 @@ class LinkedLandmarks:
 
     def _link_landmarks(self) -> None:
         """
-        Create the links between the landmarks in the list by setting their .next_uuid and the .time_to_next attributes.
+        Create the links between the landmarks in the list by setting their 
+        .next_uuid and the .time_to_next attributes.
         """
 
         # Mark secondary landmarks as such
@@ -35,30 +45,34 @@ class LinkedLandmarks:
             time_to_next = get_time(landmark.location, self._landmarks[i + 1].location)
             landmark.time_to_reach_next = time_to_next
             self.total_time += time_to_next
+            self.total_time += landmark.duration
 
         self._landmarks[-1].next_uuid = None
         self._landmarks[-1].time_to_reach_next = 0
 
     def update_secondary_landmarks(self) -> None:
+        """
+        Mark landmarks with lower importance as secondary.
+        """
         # Extract the attractiveness scores and sort them in descending order
         scores = sorted([landmark.attractiveness for landmark in self._landmarks], reverse=True)
-        
+
         # Determine the 10th highest score
         if len(scores) >= 10:
             threshold_score = scores[9]
         else:
-            # If there are fewer than 10 landmarks, use the lowest score in the list as the threshold
+            # If there are fewer than 10 landmarks, use the lowest score as the threshold
             threshold_score = min(scores) if scores else 0
-        
+
         # Update 'is_secondary' for landmarks with attractiveness below the threshold score
         for landmark in self._landmarks:
-            if landmark.attractiveness < threshold_score and landmark.type not in ["start", "finish"]:
+            if (landmark.attractiveness < threshold_score and landmark.type not in ["start", "finish"]):
                 landmark.is_secondary = True
 
 
     def __getitem__(self, index: int) -> Landmark:
         return self._landmarks[index]
-    
+
 
     def __str__(self) -> str:
         return f"LinkedLandmarks [{' ->'.join([str(landmark) for landmark in self._landmarks])}]"

backend/src/structs/preferences.py

@@ -1,12 +1,26 @@
-from pydantic import BaseModel
+"""Defines the Preferences used as input for trip generation."""
+
 from typing import Optional, Literal
+from pydantic import BaseModel
+
 
 class Preference(BaseModel) :
+    """
+    Type of preference.
+
+    Attributes:
+        type: what kind of landmark type.
+        score: how important that type is.
+    """
     type: Literal['sightseeing', 'nature', 'shopping', 'start', 'finish']
     score: int          # score could be from 1 to 5
 
+
 # Input for optimization
 class Preferences(BaseModel) :
+    """"
+    Full collection of preferences needed to generate a personalized trip.
+    """
     # Sightseeing / History & Culture (Musées, bâtiments historiques, opéras, églises)
     sightseeing : Preference
 
@@ -16,5 +30,5 @@ class Preferences(BaseModel) :
     # Shopping (diriger plutôt vers des zones / rues commerçantes)
     shopping : Preference
 
-    max_time_minute: Optional[int] = 6*60
+    max_time_minute: Optional[int] = 3*60
     detour_tolerance_minute: Optional[int] = 0

backend/src/structs/trip.py

@@ -1,17 +1,31 @@
+"""Definition of the Trip class."""
+
+import uuid
 from pydantic import BaseModel, Field
 from pymemcache.client.base import Client
 
 from .linked_landmarks import LinkedLandmarks
-import uuid
+
 
 class Trip(BaseModel):
+    """"
+    A Trip represents the final guided tour that can be passed to frontend.
+
+    Attributes:
+        uuid: unique identifier for this particular trip.
+        total_time: duration of the trip (in minutes).
+        first_landmark_uuid: unique identifier of the first Landmark to visit.
+
+    Methods:
+        from_linked_landmarks: create a Trip from LinkedLandmarks object.
+    """
     uuid: str = Field(default_factory=uuid.uuid4)
     total_time: int
     first_landmark_uuid: str
 
 
     @classmethod
-    def from_linked_landmarks(self, landmarks: LinkedLandmarks, cache_client: Client) -> "Trip":
+    def from_linked_landmarks(cls, landmarks: LinkedLandmarks, cache_client: Client) -> "Trip":
         """
         Initialize a new Trip object and ensure it is stored in the cache.
         """
@@ -22,8 +36,11 @@ class Trip(BaseModel):
 
         # Store the trip in the cache
         cache_client.set(f"trip_{trip.uuid}", trip)
-        # make sure to await the result (noreply=False). Otherwise the cache might not be inplace when the trip is actually requested
-        cache_client.set_many({f"landmark_{landmark.uuid}": landmark for landmark in landmarks}, expire=3600, noreply=False)
+
+        # Make sure to await the result (noreply=False).
+        # Otherwise the cache might not be inplace when the trip is actually requested.
+        cache_client.set_many({f"landmark_{landmark.uuid}": landmark for landmark in landmarks},
+                              expire=3600, noreply=False)
         # is equivalent to:
         # for landmark in landmarks:
         #     cache_client.set(f"landmark_{landmark.uuid}", landmark, expire=3600)

backend/src/tester.py

@@ -1,80 +0,0 @@
-import logging
-import yaml
-
-from utils.landmarks_manager import LandmarkManager
-from utils.optimizer import Optimizer
-from utils.refiner import Refiner
-from structs.landmark import Landmark
-from structs.linked_landmarks import LinkedLandmarks
-from structs.preferences import Preferences, Preference
-
-
-logger = logging.getLogger(__name__)
-
-
-
-def test(start_coords: tuple[float, float], finish_coords: tuple[float, float] = None) -> list[Landmark]:
-    manager = LandmarkManager()
-    optimizer = Optimizer()
-    refiner = Refiner(optimizer=optimizer)
-
-    
-    preferences = Preferences(
-        sightseeing=Preference(type='sightseeing', score = 5),
-        nature=Preference(type='nature', score = 5),
-        shopping=Preference(type='shopping', score = 5),
-        max_time_minute=15,
-        detour_tolerance_minute=0
-    )
-
-    # Create start and finish 
-    if finish_coords is None :
-        finish_coords = start_coords
-    start = Landmark(name='start', type='start', location=start_coords, osm_type='', osm_id=0, attractiveness=0, n_tags = 0)
-    finish = Landmark(name='finish', type='finish', location=finish_coords, osm_type='', osm_id=0, attractiveness=0, n_tags = 0)
-    #finish = Landmark(name='finish', type=LandmarkType(landmark_type='finish'), location=(48.8777055, 2.3640967), osm_type='finish', osm_id=0, attractiveness=0, must_do=True, n_tags = 0)
-    #start = Landmark(name='start', type=LandmarkType(landmark_type='start'), location=(48.847132, 2.312359), osm_type='start', osm_id=0, attractiveness=0, must_do=True, n_tags = 0)
-    #finish = Landmark(name='finish', type=LandmarkType(landmark_type='finish'), location=(48.843185, 2.344533), osm_type='finish', osm_id=0, attractiveness=0, must_do=True, n_tags = 0)
-    #finish = Landmark(name='finish', type=LandmarkType(landmark_type='finish'), location=(48.847132, 2.312359), osm_type='finish', osm_id=0, attractiveness=0, must_do=True, n_tags = 0)
-    
-
-
-    # Generate the landmarks from the start location
-    landmarks, landmarks_short = manager.generate_landmarks_list(
-        center_coordinates = start_coords,
-        preferences = preferences
-    )
-    
-    # Store data to file for debug purposes
-    # write_data(landmarks, "landmarks_Strasbourg.txt")
-
-    # Insert start and finish to the landmarks list
-    landmarks_short.insert(0, start)
-    landmarks_short.append(finish)
-
-    # First stage optimization
-    base_tour = optimizer.solve_optimization(max_time=preferences.max_time_minute, landmarks=landmarks_short)
-
-    # Second stage using linear optimization
-    refined_tour = refiner.refine_optimization(all_landmarks=landmarks, base_tour=base_tour, max_time = preferences.max_time_minute, detour = preferences.detour_tolerance_minute)
-
-    linked_tour = LinkedLandmarks(refined_tour)
-    total_time = 0           
-    logger.info("Optimized route : ")
-    for l in linked_tour :
-        logger.info(f"{l}")
-    logger.info(f"Estimated length of tour : {linked_tour.total_time} mintutes and visiting {len(linked_tour._landmarks)} landmarks.")
-
-    # with open('linked_tour.yaml', 'w') as f:
-    #     yaml.dump(linked_tour.asdict(), f)
-
-    return linked_tour
-
-
-# test(tuple((48.8344400, 2.3220540)))       # Café Chez César 
-# test(tuple((48.8375946, 2.2949904)))       # Point random
-# test(tuple((47.377859, 8.540585)))         # Zurich HB
-# test(tuple((45.758217, 4.831814)))         # Lyon Bellecour
-# test(tuple((48.5848435, 7.7332974)))       # Strasbourg Gare
-# test(tuple((48.2067858, 16.3692340)))      # Vienne
-test(tuple((48.084588, 7.280405)))         # Turckheim 

backend/src/tests/test_invalid_input.py

@@ -0,0 +1,62 @@
+"""Collection of tests to ensure correct handling of invalid input."""
+
+from fastapi.testclient import TestClient
+import pytest
+
+from ..main import app
+
+
+@pytest.fixture(scope="module")
+def invalid_client():
+    """Client used to call the app."""
+    return TestClient(app)
+
+
+@pytest.mark.parametrize(
+    "start,preferences,status_code",
+    [
+        # Invalid case: no preferences at all.
+        ([48.8566, 2.3522], {}, 422),
+
+        # Invalid cases: incomplete preferences.
+        ([48.084588, 7.280405], {"sightseeing": {"type": "nature", "score": 5}, # no shopping
+                                 "nature": {"type": "nature", "score": 5},
+                                 }, 422),
+        ([48.084588, 7.280405], {"sightseeing": {"type": "nature", "score": 5}, # no nature
+                                 "shopping": {"type": "shopping", "score": 5},
+                                 }, 422),
+        ([48.084588, 7.280405], {"nature": {"type": "nature", "score": 5},      # no sightseeing
+                                 "shopping": {"type": "shopping", "score": 5},
+                                 }, 422),
+
+        # Invalid cases: unexisting coords
+        ([91, 181], {"sightseeing": {"type": "nature", "score": 5},
+                     "nature": {"type": "nature", "score": 5},
+                     "shopping": {"type": "shopping", "score": 5},
+                    }, 423),
+        ([-91, 181], {"sightseeing": {"type": "nature", "score": 5},
+                     "nature": {"type": "nature", "score": 5},
+                     "shopping": {"type": "shopping", "score": 5},
+                    }, 423),
+        ([91, -181], {"sightseeing": {"type": "nature", "score": 5},
+                     "nature": {"type": "nature", "score": 5},
+                     "shopping": {"type": "shopping", "score": 5},
+                    }, 423),
+        ([-91, -181], {"sightseeing": {"type": "nature", "score": 5},
+                     "nature": {"type": "nature", "score": 5},
+                     "shopping": {"type": "shopping", "score": 5},
+                    }, 423),
+    ]
+)
+def test_input(invalid_client, start, preferences, status_code):   # pylint: disable=redefined-outer-name
+    """
+    Test new trip creation with different sets of preferences and locations.
+    """
+    response = invalid_client.post(
+        "/trip/new",
+        json={
+            "preferences": preferences,
+            "start": start
+        }
+    )
+    assert response.status_code == status_code

backend/src/tests/test_main.py

@@ -0,0 +1,98 @@
+"""Collection of tests to ensure correct implementation and track progress. """
+
+from fastapi.testclient import TestClient
+import pytest
+
+from .test_utils import landmarks_to_osmid, load_trip_landmarks, log_trip_details
+from ..main import app
+
+@pytest.fixture(scope="module")
+def client():
+    """Client used to call the app."""
+    return TestClient(app)
+
+
+def test_turckheim(client, request):    # pylint: disable=redefined-outer-name
+    """
+    Test n°1 : Custom test in Turckheim to ensure small villages are also supported.
+
+    Args:
+        client:
+        request:
+    """
+    duration_minutes = 15
+    response = client.post(
+        "/trip/new",
+        json={
+            "preferences": {"sightseeing": {"type": "sightseeing", "score": 5},
+            "nature": {"type": "nature", "score": 5},
+            "shopping": {"type": "shopping", "score": 5},
+            "max_time_minute": duration_minutes,
+            "detour_tolerance_minute": 0},
+            "start": [48.084588, 7.280405]
+            }
+        )
+    result = response.json()
+    landmarks = load_trip_landmarks(client, result['first_landmark_uuid'])
+
+    # Add details to report
+    log_trip_details(request, landmarks, result['total_time'], duration_minutes)
+
+    # checks :
+    assert response.status_code == 200  # check for successful planning
+    assert isinstance(landmarks, list)  # check that the return type is a list
+    assert duration_minutes*0.8 < int(result['total_time']) < duration_minutes*1.2
+    assert len(landmarks) > 2           # check that there is something to visit
+
+
+def test_bellecour(client, request) :   # pylint: disable=redefined-outer-name
+    """
+    Test n°2 : Custom test in Lyon centre to ensure proper decision making in crowded area.
+    
+    Args:
+        client:
+        request:
+    """
+    duration_minutes = 30
+    response = client.post(
+        "/trip/new",
+        json={
+            "preferences": {"sightseeing": {"type": "sightseeing", "score": 5},
+                            "nature": {"type": "nature", "score": 5},
+                            "shopping": {"type": "shopping", "score": 5},
+                            "max_time_minute": duration_minutes,
+                            "detour_tolerance_minute": 0},
+            "start": [45.7576485, 4.8330241]
+            }
+        )
+    result = response.json()
+    landmarks = load_trip_landmarks(client, result['first_landmark_uuid'])
+    osm_ids = landmarks_to_osmid(landmarks)
+
+    # Add details to report
+    log_trip_details(request, landmarks, result['total_time'], duration_minutes)
+
+    # checks :
+    assert response.status_code == 200  # check for successful planning
+    assert duration_minutes*0.8 < int(result['total_time']) < duration_minutes*1.2
+    assert 136200148 in osm_ids         # check for Cathédrale St. Jean in trip
+
+
+
+# def test_new_trip_single_prefs(client):
+#     response = client.post(
+#         "/trip/new",
+#         json={
+#             "preferences": {"sightseeing": {"type": "sightseeing", "score": 1},
+#             "nature": {"type": "nature", "score": 1},
+#             "shopping": {"type": "shopping", "score": 1},
+#             "max_time_minute": 360,
+#             "detour_tolerance_minute": 0},
+#             "start": [48.8566, 2.3522]
+#             }
+#         )
+#     assert response.status_code == 200
+
+
+# def test_new_trip_matches_prefs(client):
+#     pass

backend/src/tests/test_utils.py

@@ -0,0 +1,90 @@
+"""Helper methods for testing."""
+from typing import List
+from fastapi import HTTPException
+
+from ..structs.landmark import Landmark
+
+
+def landmarks_to_osmid(landmarks: List[Landmark]) -> List[int] :
+    """
+    Convert the list of landmarks into a list containing their osm ids for quick landmark checking.
+    
+    Args :
+        landmarks (list): the list of landmarks
+    
+    Returns :
+        ids (list)      : the list of corresponding OSM ids
+    """
+    ids = []
+    for landmark in landmarks :
+        ids.append(landmark.osm_id)
+
+    return ids
+
+def fetch_landmark(client, landmark_uuid: str):
+    """
+    Fetch landmark data from the API based on the landmark UUID.
+
+    Args:
+        landmark_uuid (str): The UUID of the landmark.
+
+    Returns:
+        dict: Landmark data fetched from the API.
+    """
+    response = client.get(f"/landmark/{landmark_uuid}")
+
+    if response.status_code != 200:
+        raise HTTPException(status_code=999,
+                            detail=f"Failed to fetch landmark with UUID {landmark_uuid}: {response.status_code}")
+
+    json_data = response.json()
+
+    if "detail" in json_data:
+        raise HTTPException(status_code=999, detail=json_data["detail"])
+
+
+    return json_data
+
+
+def load_trip_landmarks(client, first_uuid: str) -> List[Landmark]:
+    """
+    Load all landmarks for a trip using the response from the API.
+
+    Args:
+        first_uuid (str) : The first UUID of the landmark.
+
+    Returns:
+        landmarks (list) : An list containing all landmarks for the trip.
+    """
+    landmarks = []
+    next_uuid = first_uuid
+
+    while next_uuid is not None:
+        landmark_data = fetch_landmark(client, next_uuid)
+        # # Convert UUIDs to strings explicitly
+        # landmark_data = {
+        #     key: str(value) if isinstance(value, UUID) else value
+        #     for key, value in landmark_data.items()
+        # }
+        landmarks.append(Landmark(**landmark_data)) # Create Landmark objects
+        next_uuid = landmark_data.get('next_uuid')  # Prepare for the next iteration
+
+    return landmarks
+
+
+def log_trip_details(request, landmarks: List[Landmark], duration: int, target_duration: int) :
+    """
+    Allows to show the detailed trip in the html test report.
+    
+    Args:
+        request:
+        landmarks (list): the ordered list of visited landmarks 
+        duration (int): the total duration of this trip
+        target_duration(int): the target duration of this trip
+    """
+    trip_string = [f"{landmark.name} ({landmark.attractiveness} | {landmark.duration}) - {landmark.time_to_reach_next}" for landmark in landmarks]
+
+    # Pass additional info to pytest for reporting
+    request.node.trip_details = trip_string
+    request.node.trip_duration = str(duration)              # result['total_time']
+    request.node.target_duration = str(target_duration)

backend/src/utils/get_time_separation.py

@@ -1,9 +1,9 @@
 import yaml
 from math import sin, cos, sqrt, atan2, radians
 
-import constants
+from ..constants import OPTIMIZER_PARAMETERS_PATH
 
-with constants.OPTIMIZER_PARAMETERS_PATH.open('r') as f:
+with OPTIMIZER_PARAMETERS_PATH.open('r') as f:
     parameters = yaml.safe_load(f)
     DETOUR_FACTOR = parameters['detour_factor']
     AVERAGE_WALKING_SPEED = parameters['average_walking_speed']

backend/src/utils/landmarks_manager.py

@@ -5,10 +5,11 @@ import logging
 from OSMPythonTools.overpass import Overpass, overpassQueryBuilder
 from OSMPythonTools.cachingStrategy import CachingStrategy, JSON
 
-from structs.preferences import Preferences
-from structs.landmark import Landmark
+from ..structs.preferences import Preferences
+from ..structs.landmark import Landmark
 from .take_most_important import take_most_important
-import constants
+
+from ..constants import AMENITY_SELECTORS_PATH, LANDMARK_PARAMETERS_PATH, OPTIMIZER_PARAMETERS_PATH, OSM_CACHE_DIR
 
 # silence the overpass logger
 logging.getLogger('OSMPythonTools').setLevel(level=logging.CRITICAL)
@@ -27,10 +28,10 @@ class LandmarkManager:
 
     def __init__(self) -> None:
 
-        with constants.AMENITY_SELECTORS_PATH.open('r') as f:
+        with AMENITY_SELECTORS_PATH.open('r') as f:
             self.amenity_selectors = yaml.safe_load(f)
 
-        with constants.LANDMARK_PARAMETERS_PATH.open('r') as f:
+        with LANDMARK_PARAMETERS_PATH.open('r') as f:
             parameters = yaml.safe_load(f)
             self.max_bbox_side = parameters['city_bbox_side']
             self.radius_close_to = parameters['radius_close_to']
@@ -39,18 +40,19 @@ class LandmarkManager:
             self.overall_coeff = parameters['overall_coeff']
             self.tag_exponent = parameters['tag_exponent']
             self.image_bonus = parameters['image_bonus']
+            self.name_bonus = parameters['name_bonus']
             self.wikipedia_bonus = parameters['wikipedia_bonus']
             self.viewpoint_bonus = parameters['viewpoint_bonus']
             self.pay_bonus = parameters['pay_bonus']
             self.N_important = parameters['N_important']
 
-        with constants.OPTIMIZER_PARAMETERS_PATH.open('r') as f:
+        with OPTIMIZER_PARAMETERS_PATH.open('r') as f:
             parameters = yaml.safe_load(f)
             self.walking_speed = parameters['average_walking_speed']
             self.detour_factor = parameters['detour_factor']
 
         self.overpass = Overpass()
-        CachingStrategy.use(JSON, cacheDir=constants.OSM_CACHE_DIR)
+        CachingStrategy.use(JSON, cacheDir=OSM_CACHE_DIR)
 
 
     def generate_landmarks_list(self, center_coordinates: tuple[float, float], preferences: Preferences) -> tuple[list[Landmark], list[Landmark]]:
@@ -61,7 +63,7 @@ class LandmarkManager:
         and current location. It scores and corrects these landmarks, removes duplicates, and then selects the most important
         landmarks based on a predefined criterion.
 
-        Parameters:
+        Args:
         center_coordinates (tuple[float, float]): The latitude and longitude of the center location around which to search.
         preferences (Preferences): The user's preference settings that influence the landmark selection.
 
@@ -202,18 +204,29 @@ class LandmarkManager:
         """
         return_list = []
 
+        if landmarktype == 'nature' : query_conditions = []
+        else : query_conditions = ['count_tags()>5']
+
         # caution, when applying a list of selectors, overpass will search for elements that match ALL selectors simultaneously
         # we need to split the selectors into separate queries and merge the results
         for sel in dict_to_selector_list(amenity_selector):
             self.logger.debug(f"Current selector: {sel}")
+
+            query_conditions = ['count_tags()>5']
+            element_types = ['way', 'relation']
+
+            if 'viewpoint' in sel :
+                query_conditions = []
+                element_types.append('node')
+
             query = overpassQueryBuilder(
                 bbox = bbox,
-                elementType = ['way', 'relation'],
+                elementType = element_types,
                 # selector can in principle be a list already,
                 # but it generates the intersection of the queries
                 # we want the union
                 selector = sel,
-                conditions = ['count_tags()>5'],
+                conditions = query_conditions,        # except for nature....
                 includeCenter = True,
                 out = 'body'
                 )
@@ -229,18 +242,23 @@ class LandmarkManager:
 
                 name = elem.tag('name')
                 location = (elem.centerLat(), elem.centerLon())
+                osm_type = elem.type()              # Add type: 'way' or 'relation'
+                osm_id = elem.id()                  # Add OSM id 
 
                 # TODO: exclude these from the get go
-                # skip if unprecise location
+                # handle unprecise and no-name locations
                 if name is None or location[0] is None:
-                    continue
+                    if osm_type == 'node' and 'viewpoint' in elem.tags().values(): 
+                        name = 'Viewpoint'
+                        name_en = 'Viewpoint'
+                        location = (elem.lat(), elem.lon())
+                    else : 
+                        continue
 
                 # skip if part of another building
                 if 'building:part' in elem.tags().keys() and elem.tag('building:part') == 'yes':
                     continue
             
-                osm_type = elem.type()              # Add type: 'way' or 'relation'
-                osm_id = elem.id()                  # Add OSM id 
                 elem_type = landmarktype            # Add the landmark type as 'sightseeing, 
                 n_tags = len(elem.tags().keys())    # Add number of tags
                 score = n_tags**self.tag_exponent   # Add score
@@ -248,59 +266,76 @@ class LandmarkManager:
                 image_url = None
                 name_en = None
 
-                # Adjust scoring
+                # Adjust scoring, browse through tag keys
                 skip = False
-                for tag in elem.tags().keys():
-                    if "pay" in tag:
+                for tag_key in elem.tags().keys():
+                    if "pay" in tag_key:
                         # payment options are misleading and should not count for the scoring.
                         score += self.pay_bonus
 
-                    if "disused" in tag:
+                    if "disused" in tag_key:
                         # skip disused amenities
                         skip = True
                         break
 
-                    if "wiki" in tag:
+                    if "boundary" in tag_key:
+                        # skip "areas" like administrative boundaries and stuff
+                        skip = True
+                        break
+
+                    if "historic" in tag_key and elem.tag('historic') in ['manor', 'optical_telegraph', 'pound', 'shieling', 'wayside_cross']:
+                        # skip useless amenities
+                        skip = True
+                        break
+
+                    if "name" in tag_key :
+                        score += self.name_bonus
+
+                    if "wiki" in tag_key:
                         # wikipedia entries count more
                         score += self.wikipedia_bonus
 
-                    if "viewpoint" in tag:
-                        # viewpoints must count more
-                        score += self.viewpoint_bonus
-                        duration = 10
-
-                    if "image" in tag:
+                    if "image" in tag_key:
                         # images must count more
                         score += self.image_bonus
 
                     if elem_type != "nature":
-                        if "leisure" in tag and elem.tag('leisure') == "park":
+                        if "leisure" in tag_key and elem.tag('leisure') == "park":
                             elem_type = "nature"
 
                     if landmarktype != "shopping":
-                        if "shop" in tag:
+                        if "shop" in tag_key:
                             skip = True
                             break
 
-                        if tag == "building" and elem.tag('building') in ['retail', 'supermarket', 'parking']:
+                        if tag_key == "building" and elem.tag('building') in ['retail', 'supermarket', 'parking']:
                             skip = True
                             break
 
                     # Extract image, website and english name
-                    if tag in ['website', 'contact:website']:
-                        website_url = elem.tag(tag)
-                    if tag == 'image':
+                    if tag_key in ['website', 'contact:website']:
+                        website_url = elem.tag(tag_key)
+                    if tag_key == 'image':
                         image_url = elem.tag('image')
-                    if tag =='name:en':
+                    if tag_key =='name:en':
                         name_en = elem.tag('name:en')
 
                 if skip:
                     continue
 
+                # Don't visit random apartments
+                if 'apartments' in elem.tags().values():
+                    continue
+
                 score = score_function(score)
                 if "place_of_worship" in elem.tags().values():
                     score = score * self.church_coeff
                     duration = 10
+
+                if 'viewpoint' in elem.tags().values() :
+                    # viewpoints must count more
+                    score += self.viewpoint_bonus
+                    duration = 10
                 
                 elif "museum" in elem.tags().values() or "aquarium" in elem.tags().values() or "planetarium" in elem.tags().values():
                     duration = 60

backend/src/utils/optimizer.py

@@ -4,9 +4,9 @@ import numpy as np
 from scipy.optimize import linprog
 from collections import defaultdict, deque
 
-from structs.landmark import Landmark
+from ..structs.landmark import Landmark
 from .get_time_separation import get_time
-import constants
+from ..constants import OPTIMIZER_PARAMETERS_PATH
 
     
 
@@ -26,7 +26,7 @@ class Optimizer:
     def __init__(self) :
 
         # load parameters from file
-        with constants.OPTIMIZER_PARAMETERS_PATH.open('r') as f:
+        with OPTIMIZER_PARAMETERS_PATH.open('r') as f:
             parameters = yaml.safe_load(f)
             self.detour_factor = parameters['detour_factor']
             self.average_walking_speed = parameters['average_walking_speed']

backend/src/utils/refiner.py

@@ -4,10 +4,10 @@ from shapely import buffer, LineString, Point, Polygon, MultiPoint, concave_hull
 from math import pi
 from typing import List
 
-from structs.landmark import Landmark
+from ..structs.landmark import Landmark
 from . import take_most_important, get_time_separation
 from .optimizer import Optimizer
-import constants
+from ..constants import OPTIMIZER_PARAMETERS_PATH
 
 
 
@@ -25,7 +25,7 @@ class Refiner :
         self.optimizer = optimizer
 
         # load parameters from file
-        with constants.OPTIMIZER_PARAMETERS_PATH.open('r') as f:
+        with OPTIMIZER_PARAMETERS_PATH.open('r') as f:
             parameters = yaml.safe_load(f)
             self.detour_factor = parameters['detour_factor']
             self.detour_corridor_width = parameters['detour_corridor_width']
@@ -38,11 +38,11 @@ class Refiner :
         Create a corridor around the path connecting the landmarks.
 
         Args:
-            landmarks (list[Landmark]): the landmark path around which to create the corridor
-            width (float): Width of the corridor in meters.
+            landmarks (list[Landmark]) : the landmark path around which to create the corridor
+            width (float) : width of the corridor in meters.
 
         Returns:
-            Geometry: A buffered geometry object representing the corridor around the path.
+            Geometry: a buffered geometry object representing the corridor around the path.
         """
 
         corrected_width = (180*width)/(6371000*pi)

backend/src/utils/take_most_important.py

@@ -1,9 +1,9 @@
-from structs.landmark import Landmark
+from ..structs.landmark import Landmark
 
 def take_most_important(landmarks: list[Landmark], n_important) -> list[Landmark]:
     """
     Given a list of landmarks, return the n_important most important landmarks
-    Parameters:
+    Args:
     landmarks: list[Landmark] - list of landmarks
     n_important: int - number of most important landmarks to return
     Returns:

backend/test.py

@@ -1,111 +0,0 @@
-import numpy as np
-
-def euclidean_distance(p1, p2):
-    print(p1, p2)
-    return np.sqrt((p1[0] - p2[0])**2 + (p1[1] - p2[1])**2)
-
-
-def maximize_score(places, max_distance, fixed_entry, top_k=3):
-    """
-    Maximizes the total score of visited places while staying below the maximum distance.
-    
-    Parameters:
-    places (list of tuples): Each tuple contains (score, (x, y), location).
-    max_distance (float): The maximum distance that can be traveled.
-    fixed_entry (tuple): The place that needs to be visited independently of its score.
-    top_k (int): Number of top candidates to consider in each iteration.
-    
-    Returns:
-    list of tuples: The visited places.
-    float: The total score of the visited places.
-    """
-    # Initialize total distance and score
-    total_distance = 0
-    total_score = 0
-    visited_places = []
-
-    # Add the fixed entry to the visited list
-    score, (x, y), _ = fixed_entry
-    visited_places.append(fixed_entry)
-    total_score += score
-
-    # Remove the fixed entry from the list of places
-    remaining_places = [place for place in places if place != fixed_entry]
-
-    # Sort remaining places by score-to-distance ratio
-    
-    remaining_places.sort(key=lambda p: p[0] / euclidean_distance((x, y), (p[1][0], p[1][1])), reverse=True)
-
-    # Add places to the visited list if they don't exceed the maximum distance
-    current_location = (x, y)
-    while remaining_places and total_distance < max_distance:
-        # Consider top_k candidates
-        candidates = remaining_places[:top_k]
-        best_candidate = None
-        best_score_increase = -np.inf
-
-        for candidate in candidates:
-            score, (cx, cy), location = candidate
-            distance = euclidean_distance(current_location, (cx, cy))
-            if total_distance + distance <= max_distance:
-                score_increase = score / distance
-                if score_increase > best_score_increase:
-                    best_score_increase = score_increase
-                    best_candidate = candidate
-
-        if best_candidate:
-            visited_places.append(best_candidate)
-            total_distance += euclidean_distance(current_location, best_candidate[1])
-            total_score += best_candidate[0]
-            current_location = best_candidate[1]
-            remaining_places.remove(best_candidate)
-        else:
-            break
-
-    return visited_places, total_score
-
-# Example usage
-places = [
-    (10, (0, 0), 'A'),
-    (8, (4, 2), 'B'),
-    (15, (6, 4), 'C'),
-    (7, (5, 6), 'D'),
-    (12, (1, 8), 'E'),
-    (14, (34, 10), 'F'),
-    (15, (65, 12), 'G'),
-    (12, (3, 14), 'H'),
-    (12, (15, 1), 'I'),
-    (7, (17, 4), 'J'),
-    (12, (3, 3), 'K'),
-    (4, (21, 22), 'L'),
-    (12, (23, 24), 'M'),
-    (4, (25, 26), 'N'),
-    (2, (27, 28), 'O'),
-]
-fixed_entry = (10, (0, 0), 'A')
-max_distance = 50
-
-visited_places, total_score = maximize_score(places, max_distance, fixed_entry)
-print("Visited Places:", visited_places)
-print("Total Score:", total_score)
-
-import matplotlib.pyplot as plt
-
-# Plot the route
-def plot_route(visited_places):
-    x_coords = [place[1][0] for place in visited_places]
-    y_coords = [place[1][1] for place in visited_places]
-    labels = [place[2] for place in visited_places]
-
-    plt.figure(figsize=(10, 6))
-    plt.plot(x_coords, y_coords, marker='o', linestyle='-', color='b')
-    for i, label in enumerate(labels):
-        plt.text(x_coords[i], y_coords[i], label, fontsize=12, ha='right')
-
-    plt.title('Route of Visited Places')
-    plt.xlabel('X Coordinate')
-    plt.ylabel('Y Coordinate')
-    plt.grid(True)
-    plt.savefig('route.png')
-
-plot_route(visited_places)

frontend/lib/layout.dart

@@ -1,6 +1,3 @@
-import 'package:anyway/main.dart';
-import 'package:anyway/modules/help_dialog.dart';
-import 'package:anyway/pages/current_trip.dart';
 import 'package:anyway/pages/settings.dart';
 import 'package:flutter/material.dart';
 
@@ -11,24 +8,22 @@ import 'package:anyway/modules/trips_saved_list.dart';
 import 'package:anyway/utils/load_trips.dart';
 
 import 'package:anyway/pages/new_trip_location.dart';
+import 'package:anyway/pages/current_trip.dart';
 import 'package:anyway/pages/onboarding.dart';
 
 
 
 
-// BasePage is the scaffold that holds a child page and a side drawer
-// The side drawer is the main way to switch between pages
-
+// BasePage is the scaffold that holds all other pages
+// A side drawer is used to switch between pages
 class BasePage extends StatefulWidget {
-  final Widget mainScreen;
-  final Widget title;
-  final List<String> helpTexts;
+  final String mainScreen;
+  final Trip? trip;
 
   const BasePage({
     super.key,
     required this.mainScreen,
-    this.title = const Text(APP_NAME),
-    this.helpTexts = const [],
+    this.trip,
   });
 
   @override
@@ -39,25 +34,53 @@ class _BasePageState extends State<BasePage> {
 
   @override
   Widget build(BuildContext context) {
-    savedTrips.loadTrips();
-
+    Widget currentView = const Text("loading...");
+    Future<List<Trip>> trips = loadTrips();
+    
+    
+    if (widget.mainScreen == "map") {
+      if (widget.trip != null) {
+        currentView = TripPage(trip: widget.trip!);
+      } else {
+        currentView = FutureBuilder(
+          future: trips,
+          builder: (context, snapshot) {
+            if (snapshot.hasData) {
+              List<Trip> availableTrips = snapshot.data!;
+              if (availableTrips.isNotEmpty) {
+                return TripPage(trip: availableTrips[0]);
+              } else {
+                return Scaffold(
+                  body: Center(
+                    child: Text("Wow, so empty!"),
+                  ),
+                  floatingActionButton: FloatingActionButton.extended(
+                    onPressed: () {
+                      Navigator.of(context).push(
+                        MaterialPageRoute(
+                          builder: (context) => const NewTripPage()
+                        )
+                      );
+                    },
+                    label: Text("Plan a trip"),
+                  ),
+                );
+              }
+            } else {
+              return const Text("loading...");
+            }
+          },
+        );
+      }
+    } else if (widget.mainScreen == "tutorial") {
+      currentView = OnboardingPage();
+    } else if (widget.mainScreen == "settings") {
+      currentView = SettingsPage();
+    }
 
     return Scaffold(
-      appBar: AppBar(
-        title: widget.title,
-        actions: [
-          IconButton(
-            icon: const Icon(Icons.help),
-            tooltip: 'Help',
-            onPressed: () {
-              if (widget.helpTexts.isNotEmpty) {
-                helpDialog(context, widget.helpTexts[0], widget.helpTexts[1]);
-              }
-            }
-          ),
-        ],
-      ),
-      body: Center(child: widget.mainScreen),
+      appBar: AppBar(title: Text(APP_NAME)),
+      body: Center(child: currentView),
       drawer: Drawer(
         child: Column(
           children: [
@@ -81,8 +104,7 @@ class _BasePageState extends State<BasePage> {
             ListTile(
               title: const Text('Your Trips'),
               leading: const Icon(Icons.map),
-              // TODO: this is not working!
-              selected: widget.mainScreen is TripPage,
+              selected: widget.mainScreen == "map",
               onTap: () {},
               trailing: ElevatedButton(
                 onPressed: () {
@@ -100,11 +122,11 @@ class _BasePageState extends State<BasePage> {
             // through the options in the drawer if there isn't enough vertical
             // space to fit everything.
             Expanded(
-              child: TripsOverview(trips: savedTrips),
+              child: TripsOverview(trips: trips),
             ),
             ElevatedButton(
               onPressed: () async {
-                savedTrips.clearTrips();
+                removeAllTripsFromPrefs();
               },
               child: const Text('Clear trips'),
             ),
@@ -112,12 +134,11 @@ class _BasePageState extends State<BasePage> {
             ListTile(
               title: const Text('How to use'),
               leading: Icon(Icons.help),
-              // TODO: this is not working!
-              selected: widget.mainScreen is OnboardingPage,
+              selected: widget.mainScreen == "tutorial",
               onTap: () {
                 Navigator.of(context).push(
                   MaterialPageRoute(
-                    builder: (context) => OnboardingPage()
+                    builder: (context) => BasePage(mainScreen: "tutorial")
                   )
                 );
               },
@@ -127,12 +148,11 @@ class _BasePageState extends State<BasePage> {
             ListTile(
               title: const Text('Settings'),
               leading: const Icon(Icons.settings),
-              // TODO: this is not working!
-              selected: widget.mainScreen is SettingsPage,
+              selected: widget.mainScreen == "settings",
               onTap: () {
                 Navigator.of(context).push(
                   MaterialPageRoute(
-                    builder: (context) => SettingsPage()
+                    builder: (context) => BasePage(mainScreen: "settings")
                   )
                 );
               },

frontend/lib/main.dart

@@ -1,12 +1,10 @@
-import 'package:anyway/utils/get_first_page.dart';
-import 'package:anyway/utils/load_trips.dart';
 import 'package:flutter/material.dart';
 import 'package:anyway/constants.dart';
+import 'package:anyway/layout.dart';
 
 void main() => runApp(const App());
 
 final GlobalKey<ScaffoldMessengerState> rootScaffoldMessengerKey = GlobalKey<ScaffoldMessengerState>();
-final SavedTrips savedTrips = SavedTrips();
 
 class App extends StatelessWidget {
   const App({super.key});
@@ -16,7 +14,7 @@ class App extends StatelessWidget {
   Widget build(BuildContext context) {
     return MaterialApp(
       title: APP_NAME,
-      home: getFirstPage(),
+      home: BasePage(mainScreen: "map"),
       theme: APP_THEME,
       scaffoldMessengerKey: rootScaffoldMessengerKey
     );

frontend/lib/modules/current_trip_landmarks_list.dart

@@ -5,6 +5,7 @@ import 'package:flutter/material.dart';
 import 'package:anyway/modules/landmark_card.dart';
 import 'package:anyway/structs/landmark.dart';
 import 'package:anyway/structs/trip.dart';
+import 'package:anyway/main.dart';
 
 
 
@@ -24,7 +25,30 @@ List<Widget> landmarksList(Trip trip) {
 
   for (Landmark landmark in trip.landmarks) {
     children.add(
-      LandmarkCard(landmark, trip),
+      Dismissible(
+        key: ValueKey<int>(landmark.hashCode),
+        child: LandmarkCard(landmark),
+        dismissThresholds: {DismissDirection.endToStart: 0.95, DismissDirection.startToEnd: 0.95},
+        onDismissed: (direction) {
+          log('Removing ${landmark.name}');
+          trip.removeLandmark(landmark);
+
+          rootScaffoldMessengerKey.currentState!.showSnackBar(
+            SnackBar(content: Text("We won't show ${landmark.name} again"))
+          );
+        },
+
+        background: Container(color: Colors.red),
+        secondaryBackground: Container(
+          color: Colors.red,
+          child: Icon(
+            Icons.delete,
+            color: Colors.white,
+          ),
+          padding: EdgeInsets.all(15),
+          alignment: Alignment.centerRight,
+        ),
+      )
     );
 
     if (landmark.next != null) {

frontend/lib/modules/current_trip_loading_indicator.dart

@@ -1,5 +1,3 @@
-import 'dart:ui';
-
 import 'package:flutter/material.dart';
 import 'package:auto_size_text/auto_size_text.dart';
 
@@ -17,116 +15,46 @@ class CurrentTripLoadingIndicator extends StatefulWidget {
   State<CurrentTripLoadingIndicator> createState() => _CurrentTripLoadingIndicatorState();
 }
 
-
-Widget bottomLoadingIndicator = Container(
-  height: 20.0, // Increase the height to take up more vertical space
-
-  child: ImageFiltered(
-    imageFilter: ImageFilter.blur(sigmaX: 5.0, sigmaY: 5.0), // Apply blur effect
-    child: Padding(padding: EdgeInsets.all(10), child: CircularProgressIndicator(),)
-    ),
-);
-
-
-Widget loadingText(Trip trip) => FutureBuilder(
-  future: trip.cityName,
-  builder: (BuildContext context, AsyncSnapshot<String> snapshot) {
-    Widget greeter;
-
-    if (snapshot.hasData) {
-      greeter = AnimatedGradientText(
-        text: 'Generating your trip to ${snapshot.data}...',
-        style: greeterStyle,
-      );
-    } else if (snapshot.hasError) {
-      // the exact error is shown in the central part of the trip overview. No need to show it here
-      greeter = AnimatedGradientText(
-        text: 'Error while loading trip.',
-        style: greeterStyle,
-      );
-    } else {
-      greeter = AnimatedGradientText(
-        text: 'Generating your trip...',
-        style: greeterStyle,
-      );
-    }
-    return greeter;
-  }
-);
-
-class AnimatedGradientText extends StatefulWidget {
-  final String text;
-  final TextStyle style;
-
-  const AnimatedGradientText({
-    Key? key,
-    required this.text,
-    required this.style,
-  }) : super(key: key);
-
-  @override
-  _AnimatedGradientTextState createState() => _AnimatedGradientTextState();
-}
-
-class _AnimatedGradientTextState extends State<AnimatedGradientText> with SingleTickerProviderStateMixin {
-  late AnimationController _controller;
-
-  @override
-  void initState() {
-    super.initState();
-    _controller = AnimationController(
-      duration: const Duration(seconds: 1),
-      vsync: this,
-    )..repeat();
-  }
-
-  @override
-  void dispose() {
-    _controller.dispose();
-    super.dispose();
-  }
-
-  @override
-  Widget build(BuildContext context) {
-    return AnimatedBuilder(
-      animation: _controller,
-      builder: (context, child) {
-        return ShaderMask(
-          shaderCallback: (bounds) {
-            return LinearGradient(
-              colors: [Colors.blue, Colors.red, Colors.blue],
-              stops: [
-                _controller.value - 1.0,
-                _controller.value,
-                _controller.value + 1.0,
-              ],
-              tileMode: TileMode.mirror,
-            ).createShader(bounds);
-          },
-          child: Text(
-            widget.text,
-            style: widget.style,
-          ),
-        );
-      },
-    );
-  }
-}
-
-
-
-
 class _CurrentTripLoadingIndicatorState extends State<CurrentTripLoadingIndicator> {
   @override
-  Widget build(BuildContext context) => Stack(
-    fit: StackFit.expand,
-    children: [
-      Center(child: loadingText(widget.trip)),
-      Align(
-        alignment: Alignment.bottomCenter,
-        child: bottomLoadingIndicator,
-      )
-    ],
-  );
+  Widget build(BuildContext context) => Center(
+    child: FutureBuilder(
+      future: widget.trip.cityName,
+      builder: (BuildContext context, AsyncSnapshot<String> snapshot) {
+        Widget greeter;
+        Widget loadingIndicator = const Padding(
+          padding: EdgeInsets.only(top: 10),
+          child: CircularProgressIndicator()
+        );
 
-}
+        if (snapshot.hasData) {
+          greeter = AutoSizeText(
+            maxLines: 1,
+            'Generating your trip to ${snapshot.data}...',
+            style: greeterStyle,
+          );
+        } else if (snapshot.hasError) {
+          // the exact error is shown in the central part of the trip overview. No need to show it here
+          greeter = AutoSizeText(
+            maxLines: 1,
+            'Error while loading trip.',
+            style: greeterStyle,
+            );
+        } else {
+          greeter = AutoSizeText(
+            maxLines: 1,
+            'Generating your trip...',
+            style: greeterStyle,
+            );
+        }
+        return Column(
+          mainAxisAlignment: MainAxisAlignment.center,
+          children: [
+            greeter,
+            loadingIndicator,
+          ],
+        );
+      }
+    )
+  );
+}

frontend/lib/modules/current_trip_panel.dart

@@ -36,7 +36,7 @@ class _CurrentTripPanelState extends State<CurrentTripPanel> {
               child: SizedBox(
                 // reuse the exact same height as the panel has when collapsed
                 // this way the greeter will be centered when the panel is collapsed
-                height: MediaQuery.of(context).size.height * TRIP_PANEL_MIN_HEIGHT,
+                height: MediaQuery.of(context).size.height * TRIP_PANEL_MIN_HEIGHT - 20,
                 child: CurrentTripErrorMessage(trip: widget.trip)
               ),
             );
@@ -46,20 +46,19 @@ class _CurrentTripPanelState extends State<CurrentTripPanel> {
               child: SizedBox(
                 // reuse the exact same height as the panel has when collapsed
                 // this way the greeter will be centered when the panel is collapsed
-                height: MediaQuery.of(context).size.height * TRIP_PANEL_MIN_HEIGHT,
+                height: MediaQuery.of(context).size.height * TRIP_PANEL_MIN_HEIGHT - 20,
                 child: CurrentTripLoadingIndicator(trip: widget.trip),
               ),
             );
         } else {
           return ListView(
             controller: widget.controller,
-            padding: const EdgeInsets.only(top: 10, left: 10, right: 10, bottom: 30),
+            padding: const EdgeInsets.only(bottom: 30),
             children: [
               SizedBox(
                 // reuse the exact same height as the panel has when collapsed
                 // this way the greeter will be centered when the panel is collapsed
-                // note that we need to account for the padding above
-                height: MediaQuery.of(context).size.height * TRIP_PANEL_MIN_HEIGHT - 10,
+                height: MediaQuery.of(context).size.height * TRIP_PANEL_MIN_HEIGHT - 20,
                 child: CurrentTripGreeter(trip: widget.trip),
               ),
 
@@ -73,7 +72,7 @@ class _CurrentTripPanelState extends State<CurrentTripPanel> {
 
               const Padding(padding: EdgeInsets.only(top: 10)),
 
-              Center(child: saveButton(trip: widget.trip)),
+              Center(child: saveButton(widget.trip)),
             ],
           );
         }

frontend/lib/modules/current_trip_save_button.dart

@@ -3,53 +3,39 @@ import 'package:anyway/main.dart';
 import 'package:anyway/structs/trip.dart';
 import 'package:auto_size_text/auto_size_text.dart';
 import 'package:flutter/material.dart';
+import 'package:shared_preferences/shared_preferences.dart';
 
-
-class saveButton extends StatefulWidget {
-  Trip trip;
-  saveButton({super.key, required this.trip});
-
-  @override
-  State<saveButton> createState() => _saveButtonState();
-}
-
-class _saveButtonState extends State<saveButton> {
-  @override
-  Widget build(BuildContext context) {
-    return ElevatedButton(
-      onPressed: () async {
-        savedTrips.addTrip(widget.trip);
-        // SharedPreferences prefs = await SharedPreferences.getInstance();
-        // setState(() => widget.trip.toPrefs(prefs));
-        rootScaffoldMessengerKey.currentState!.showSnackBar(
-          SnackBar(
-            content: Text('Trip saved'),
-            duration: Duration(seconds: 2),
-            dismissDirection: DismissDirection.horizontal
-          )
-        );
-      },
-      child: SizedBox(
-        width: 100,
-        child: Row(
-          mainAxisAlignment: MainAxisAlignment.center,
-          children: [
-            Icon(
-              Icons.save,
-            ),
-            Expanded(
-              child: Padding(
-                padding: EdgeInsets.only(left: 10, top: 5, bottom: 5, right: 5),
-                child: AutoSizeText(
-                  'Save trip',
-                  maxLines: 2,
-                ),
-              ),
-            ),
-          ],
-        ),
+Widget saveButton(Trip trip) => ElevatedButton(
+  onPressed: () async {
+    SharedPreferences prefs = await SharedPreferences.getInstance();
+    trip.toPrefs(prefs);
+    rootScaffoldMessengerKey.currentState!.showSnackBar(
+      SnackBar(
+        content: Text('Trip saved'),
+        duration: Duration(seconds: 2),
+        dismissDirection: DismissDirection.horizontal
       )
     );
-  }
-}
+  },
+  child: SizedBox(
+    width: 100,
+    child: Row(
+      mainAxisAlignment: MainAxisAlignment.center,
+      children: [
+        Icon(
+          Icons.save,
+        ),
+        Expanded(
+          child: Padding(
+            padding: EdgeInsets.only(left: 10, top: 5, bottom: 5, right: 5),
+            child: AutoSizeText(
+              'Save trip',
+              maxLines: 2,
+            ),
+          ),
+        ),
+      ],
+    ),
+  )
+);
 

frontend/lib/modules/help_dialog.dart

@@ -1,25 +0,0 @@
-
-import 'package:flutter/material.dart';
-
-Future<void> helpDialog(BuildContext context, String title, String content) {
-  return showDialog<void>(
-    context: context,
-    builder: (BuildContext context) {
-      return AlertDialog(
-        title: Text(title),
-        content: Text(content),
-        actions: <Widget>[
-          TextButton(
-            style: TextButton.styleFrom(
-              textStyle: Theme.of(context).textTheme.labelLarge,
-            ),
-            child: const Text('Got it!'),
-            onPressed: () {
-              Navigator.of(context).pop();
-            },
-          ),
-        ],
-      );
-    },
-  );
-}

frontend/lib/modules/landmark_card.dart

@@ -1,5 +1,3 @@
-import 'package:anyway/main.dart';
-import 'package:anyway/structs/trip.dart';
 import 'package:flutter/material.dart';
 import 'package:cached_network_image/cached_network_image.dart';
 import 'package:url_launcher/url_launcher.dart';
@@ -8,12 +6,8 @@ import 'package:anyway/structs/landmark.dart';
 
 class LandmarkCard extends StatefulWidget {
   final Landmark landmark;
-  final Trip parentTrip;
   
-  LandmarkCard(
-    this.landmark,
-    this.parentTrip,
-    );
+  LandmarkCard(this.landmark);
   
   @override
   _LandmarkCardState createState() => _LandmarkCardState();
@@ -23,149 +17,110 @@ class LandmarkCard extends StatefulWidget {
 class _LandmarkCardState extends State<LandmarkCard> {
   @override
   Widget build(BuildContext context) {
-    if (widget.landmark.type == typeStart || widget.landmark.type == typeFinish) {
-      return TextButton.icon(
-        onPressed: () {},
-        icon: widget.landmark.type.icon,
-        label: Text(widget.landmark.name),
-      );
-
-    }
-    // else:
+    ThemeData theme = Theme.of(context);
     return Container(
+      height: 160,
       child: Card(
         shape: RoundedRectangleBorder(
           borderRadius: BorderRadius.circular(15.0),
         ),
         elevation: 5,
         clipBehavior: Clip.antiAliasWithSaveLayer,
-        // if the image is available, display it on the left side of the card, otherwise only display the text
-        child: widget.landmark.imageURL != null ? splitLayout() : textLayout(),
-      ),
-    );
-  }
-
-  Widget splitLayout() {
-    // If an image is available, display it on the left side of the card
-    return Row(
-      crossAxisAlignment: CrossAxisAlignment.start,
-      children: [
-        Container(
-          // the image on the left
-          width: 160,
-          height: 160,
-
-          child: CachedNetworkImage(
-            imageUrl: widget.landmark.imageURL ?? '',
-            placeholder: (context, url) => Center(child: CircularProgressIndicator()),
-            errorWidget: (context, error, stackTrace) => Icon(Icons.question_mark_outlined),
-            fit: BoxFit.cover,
-          ),
-        ),
-        Flexible(
-          child: textLayout(),
-        ),
-      ],
-    );
-  }
-
-  Widget textLayout() {
-    return Padding(
-      padding: EdgeInsets.all(10),
-      child: Column(
-        children: [
-          Row(
-            children: [
-              Flexible(
-                child: Text(
-                  widget.landmark.name,
-                  style: const TextStyle(
-                    fontSize: 18,
-                    fontWeight: FontWeight.bold,
-                  ),
-                  maxLines: 2,
-                ),
-              )
-            ],
-          ),
-          if (widget.landmark.nameEN != null)
-            Row(
-              children: [
-                Flexible(
-                  child: Text(
-                    widget.landmark.nameEN!,
-                    style: const TextStyle(
-                      fontSize: 16,
-                    ),
-                    maxLines: 1,
-                  ),
-                )
-              ],
-            ),
-          Padding(padding: EdgeInsets.only(top: 10)),
-          Align(
-            alignment: Alignment.centerLeft,
-            child: SingleChildScrollView(
-              // allows the buttons to be scrolled
-              scrollDirection: Axis.horizontal,
-              child: Wrap(
-                spacing: 10,
-                // show the type, the website, and the wikipedia link as buttons/labels in a row
-                children: [
-                  TextButton.icon(
-                    onPressed: () {},
-                    icon: widget.landmark.type.icon,
-                    label: Text(widget.landmark.type.name),
-                  ),
-                  if (widget.landmark.duration != null && widget.landmark.duration!.inMinutes > 0)
-                    TextButton.icon(
-                      onPressed: () {},
-                      icon: Icon(Icons.hourglass_bottom),
-                      label: Text('${widget.landmark.duration!.inMinutes} minutes'),
-                    ),
-                  if (widget.landmark.websiteURL != null)
-                    TextButton.icon(
-                      onPressed: () async {
-                        // open a browser with the website link
-                        await launchUrl(Uri.parse(widget.landmark.websiteURL!));
-                      },
-                      icon: Icon(Icons.link),
-                      label: Text('Website'),
-                    ),
-                  PopupMenuButton(
-                    icon: Icon(Icons.settings),
-                    style: TextButtonTheme.of(context).style,
-                    itemBuilder: (context) => [
-                      PopupMenuItem(
-                        child: ListTile(
-                          leading: Icon(Icons.delete),
-                          title: Text('Delete'),
-                          onTap: () async {
-                            widget.parentTrip.removeLandmark(widget.landmark);
-                            rootScaffoldMessengerKey.currentState!.showSnackBar(
-                              SnackBar(content: Text("We won't show ${widget.landmark.name} again"))
-                            );
-                          },
-                        ),
-                      ),
-                      PopupMenuItem(
-                        child: ListTile(
-                          leading: Icon(Icons.star),
-                          title: Text('Favorite'),
-                          onTap: () async {
-                            // delete the landmark
-                            // await deleteLandmark(widget.landmark);
-                          },
-                        ),
-                      ),
-                    ],
-                  )
-                    
-                ],
+        child: Row(
+          crossAxisAlignment: CrossAxisAlignment.start,
+          children: [
+            Container( // the image on the left
+              // inherit the height of the parent container
+              height: double.infinity,
+              // force a fixed width
+              width: 160,
+              child: CachedNetworkImage(
+                imageUrl: widget.landmark.imageURL ?? '',
+                placeholder: (context, url) => Center(child: CircularProgressIndicator()),
+                errorWidget: (context, error, stackTrace) => Icon(Icons.question_mark_outlined),
+                // TODO: make this a switch statement to load a placeholder if null
+                // cover the whole container meaning the image will be cropped
+                fit: BoxFit.cover,
               ),
             ),
-          ),
-        ],
+            Flexible(
+              child: Padding(
+                padding: EdgeInsets.all(10),
+                child: Column(
+                  children: [
+                    Row(
+                      children: [
+                        Flexible(
+                          child: Text(
+                            widget.landmark.name,
+                            style: const TextStyle(
+                              fontSize: 18,
+                              fontWeight: FontWeight.bold,
+                            ),
+                            maxLines: 2,
+                          ),
+                        )
+                      ],
+                    ),
+                    if (widget.landmark.nameEN != null)
+                      Row(
+                        children: [
+                          Flexible(
+                            child: Text(
+                              widget.landmark.nameEN!,
+                              style: const TextStyle(
+                                fontSize: 16,
+                              ),
+                              maxLines: 1,
+                            ),
+                          )
+                        ],
+                      ),
+                    SingleChildScrollView(
+                      // allows the buttons to be scrolled
+                      scrollDirection: Axis.horizontal,
+                      child: Wrap(
+                        spacing: 10,
+                        // show the type, the website, and the wikipedia link as buttons/labels in a row
+                        children: [
+                          TextButton.icon(
+                            onPressed: () {},
+                            icon: widget.landmark.type.icon,
+                            label: Text(widget.landmark.type.name),
+                          ),
+                          if (widget.landmark.duration != null && widget.landmark.duration!.inMinutes > 0)
+                            TextButton.icon(
+                              onPressed: () {},
+                              icon: Icon(Icons.hourglass_bottom),
+                              label: Text('${widget.landmark.duration!.inMinutes} minutes'),
+                            ),
+                          if (widget.landmark.websiteURL != null)
+                            TextButton.icon(
+                              onPressed: () async {
+                                // open a browser with the website link
+                                await launchUrl(Uri.parse(widget.landmark.websiteURL!));
+                              },
+                              icon: Icon(Icons.link),
+                              label: Text('Website'),
+                            ),
+                          if (widget.landmark.wikipediaURL != null)
+                            TextButton.icon(
+                              onPressed: () async {
+                                // open a browser with the wikipedia link
+                                await launchUrl(Uri.parse(widget.landmark.wikipediaURL!));
+                              },
+                              icon: Icon(Icons.book),
+                            label: Text('Wikipedia'),
+                          ),
+                        ],
+                      ),
+                    ),
+                  ],
+                ),
+              ),
+            ),
+          ],
+        ),
       ),
     );
   }

frontend/lib/modules/new_trip_button.dart

@@ -1,5 +1,5 @@
+import 'package:anyway/layout.dart';
 import 'package:anyway/main.dart';
-import 'package:anyway/pages/current_trip.dart';
 import 'package:anyway/structs/preferences.dart';
 import 'package:anyway/structs/trip.dart';
 import 'package:anyway/utils/fetch_trip.dart';
@@ -57,7 +57,7 @@ class _NewTripButtonState extends State<NewTripButton> {
       fetchTrip(trip, widget.preferences);
       Navigator.of(context).push(
         MaterialPageRoute(
-          builder: (context) => TripPage(trip: trip)
+          builder: (context) => BasePage(mainScreen: "map", trip: trip)
         )
       );
     }

frontend/lib/modules/new_trip_location_search.dart

@@ -9,15 +9,6 @@ import 'package:flutter/material.dart';
 import 'package:geolocator/geolocator.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
-const Map<String, List> debugLocations = {
-  'paris': [48.8575, 2.3514],
-  'london': [51.5074, -0.1278],
-  'new york': [40.7128, -74.0060],
-  'tokyo': [35.6895, 139.6917],
-};
-
-
-
 class NewTripLocationSearch extends StatefulWidget {
   Future<SharedPreferences> prefs = SharedPreferences.getInstance();
   Trip trip;
@@ -36,35 +27,26 @@ class _NewTripLocationSearchState extends State<NewTripLocationSearch> {
 
   setTripLocation (String query) async {
     List<Location> locations = [];
-    Location startLocation;
     log('Searching for: $query');
-    if (GeocodingPlatform.instance != null) {
-      locations.addAll(await locationFromAddress(query));
+    
+    try{
+      locations = await locationFromAddress(query);
+    } catch (e) {
+      log('No results found for: $query : $e');
     }
 
     if (locations.isNotEmpty) {
-      startLocation = locations.first;
-    } else {
-      log('No results found for: $query. Is geocoding available?');
-      log('Setting Fallback location');
-      List coordinates = debugLocations[query.toLowerCase()] ?? [48.8575, 2.3514];
-      startLocation = Location(
-        latitude: coordinates[0],
-        longitude: coordinates[1],
-        timestamp: DateTime.now(),
+      Location location = locations.first;
+      widget.trip.landmarks.clear();
+      widget.trip.addLandmark(
+        Landmark(
+          uuid: 'pending',
+          name: query,
+          location: [location.latitude, location.longitude],
+          type: typeStart
+        )
       );
     }
-
-    widget.trip.landmarks.clear();
-    widget.trip.addLandmark(
-      Landmark(
-        uuid: 'pending',
-        name: query,
-        location: [startLocation.latitude, startLocation.longitude],
-        type: typeStart
-      )
-    );
-
   }
 
   late Widget locationSearchBar = SearchBar(

frontend/lib/modules/new_trip_map.dart

@@ -26,7 +26,7 @@ class _NewTripMapState extends State<NewTripMap> {
     target: LatLng(48.8566, 2.3522),
     zoom: 11.0,
   );
-  GoogleMapController? _mapController;
+  late GoogleMapController _mapController;
   final Set<Marker> _markers = <Marker>{};
 
   _onLongPress(LatLng location) {
@@ -56,15 +56,11 @@ class _NewTripMapState extends State<NewTripMap> {
           ),
         )
       );
-      // check if the controller is ready
-
-      if (_mapController != null) {
-        _mapController!.animateCamera(
-          CameraUpdate.newLatLng(
-            LatLng(landmark.location[0], landmark.location[1])
-          )
-        );
-      }
+      _mapController.moveCamera(
+        CameraUpdate.newLatLng(
+          LatLng(landmark.location[0], landmark.location[1])
+        )
+      );
       setState(() {});
     }
   }

frontend/lib/modules/onboarding_card.dart

@@ -2,11 +2,13 @@ import 'package:flutter/material.dart';
 import 'package:flutter_svg/flutter_svg.dart';
 
 class OnboardingCard extends StatelessWidget {
-  final String title;
-  final String description;
-  final String imagePath;
+  int index;
+  String title;
+  String description;
+  String imagePath;
 
-  const OnboardingCard({
+  OnboardingCard({
+    required this.index,
     required this.title,
     required this.description,
     required this.imagePath,
@@ -14,35 +16,41 @@ class OnboardingCard extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    
-    return Padding(
-      padding: EdgeInsets.all(20),
-      child: Column(
-        mainAxisAlignment: MainAxisAlignment.center,
-        children: [
-          Text(
-            title,
-            style: TextStyle(
-              fontSize: 24,
-              fontWeight: FontWeight.bold,
-              color: Colors.white,
+    Color baseColor = Theme.of(context).colorScheme.secondary;
+    // have a different color for each card, incrementing the hue
+    Color currentColor = baseColor.withAlpha(baseColor.alpha - index * 30);
+    return Container(
+      color: currentColor,
+      alignment: Alignment.center,
+      child: Padding(
+        padding: EdgeInsets.all(20),
+        child: Column(
+          mainAxisAlignment: MainAxisAlignment.center,
+          children: [
+            Text(
+              title,
+              style: TextStyle(
+                fontSize: 24,
+                fontWeight: FontWeight.bold,
+                color: Colors.white,
+              ),
             ),
-          ),
-          Padding(padding: EdgeInsets.only(top: 20)),
-          SvgPicture.asset(
-            imagePath,
-            height: 200,
-          ),
-          Padding(padding: EdgeInsets.only(top: 20)),
-          Text(
-            description,
-            style: TextStyle(
-              fontSize: 16,
+            Padding(padding: EdgeInsets.only(top: 20)),
+            SvgPicture.asset(
+              imagePath,
+              height: 200,
+            ),
+            Padding(padding: EdgeInsets.only(top: 20)),
+            Text(
+              description,
+              style: TextStyle(
+                fontSize: 16,
+              ),
             ),
-          ),
 
-        ]
-      ),
+          ]
+        ),
+      )
     );
   }
 }

frontend/lib/modules/trips_saved_list.dart

@@ -1,12 +1,11 @@
-import 'package:anyway/pages/current_trip.dart';
-import 'package:anyway/utils/load_trips.dart';
 import 'package:flutter/material.dart';
 
+import 'package:anyway/layout.dart';
 import 'package:anyway/structs/trip.dart';
 
 
 class TripsOverview extends StatefulWidget {
-  final SavedTrips trips;
+  final Future<List<Trip>> trips;
   const TripsOverview({
     super.key,
     required this.trips,
@@ -17,34 +16,50 @@ class TripsOverview extends StatefulWidget {
 }
 
 class _TripsOverviewState extends State<TripsOverview> {
-  Widget listBuild (BuildContext context, SavedTrips trips) {
+
+  Widget listBuild (BuildContext context, AsyncSnapshot<List<Trip>> snapshot) {
     List<Widget> children;
-    List<Trip> items = trips.trips;
-    children = List<Widget>.generate(items.length, (index) {
-      Trip trip = items[index];
-      return ListTile(
-        title: FutureBuilder(
-          future: trip.cityName,
-          builder: (BuildContext context, AsyncSnapshot<String> snapshot) {
-            if (snapshot.hasData) {
-              return Text("Trip to ${snapshot.data}");
-            } else if (snapshot.hasError) {
-              return Text("Error: ${snapshot.error}");
-            } else {
-              return const Text("Trip to ...");
-            }
+    if (snapshot.hasData) {
+      children = List<Widget>.generate(snapshot.data!.length, (index) {
+        Trip trip = snapshot.data![index];
+        return ListTile(
+          title: FutureBuilder(
+            future: trip.cityName,
+            builder: (BuildContext context, AsyncSnapshot<String> snapshot) {
+              if (snapshot.hasData) {
+                return Text("Trip to ${snapshot.data}");
+              } else if (snapshot.hasError) {
+                return Text("Error: ${snapshot.error}");
+              } else {
+                return const Text("Trip to ...");
+              }
+            },
+          ),
+          leading: Icon(Icons.pin_drop),
+          onTap: () {
+            Navigator.of(context).push(
+              MaterialPageRoute(
+                builder: (context) => BasePage(mainScreen: "map", trip: trip)
+              )
+            );
           },
+        );
+      });
+    } else if (snapshot.hasError) {
+      children = [
+        const Icon(
+          Icons.error_outline,
+          color: Colors.red,
+          size: 60,
         ),
-        leading: Icon(Icons.pin_drop),
-        onTap: () {
-          Navigator.of(context).push(
-            MaterialPageRoute(
-              builder: (context) => TripPage(trip: trip)
-            )
-          );
-        },
-      );
-    });
+        Padding(
+          padding: const EdgeInsets.only(top: 16),
+          child: Text('Error: ${snapshot.error}'),
+        ),
+      ];
+    } else {
+      children = [Center(child: CircularProgressIndicator())];
+    }
 
     return ListView(
       children: children,
@@ -54,11 +69,9 @@ class _TripsOverviewState extends State<TripsOverview> {
 
   @override
   Widget build(BuildContext context) {
-    return ListenableBuilder(
-      listenable: widget.trips,
-      builder: (BuildContext context, Widget? child) {
-        return listBuild(context, widget.trips);
-      }
+    return FutureBuilder(
+      future: widget.trips,
+      builder: listBuild,
     );
   }
-}
+}

frontend/lib/pages/current_trip.dart

@@ -1,5 +1,4 @@
 import 'package:anyway/constants.dart';
-import 'package:anyway/pages/base_page.dart';
 import 'package:flutter/material.dart';
 import 'package:sliding_up_panel/sliding_up_panel.dart';
 
@@ -32,8 +31,7 @@ class _TripPageState extends State<TripPage> {
 
   @override
   Widget build(BuildContext context) {
-    return BasePage(
-      mainScreen: SlidingUpPanel(
+    return SlidingUpPanel(
         // use panelBuilder instead of panel so that we can reuse the scrollcontroller for the listview
         panelBuilder: (scrollcontroller) => CurrentTripPanel(controller: scrollcontroller, trip: widget.trip),
         // using collapsed and panelBuilder seems to show both at the same time, so we include the greeter in the panelBuilder
@@ -43,7 +41,7 @@ class _TripPageState extends State<TripPage> {
         maxHeight: MediaQuery.of(context).size.height * TRIP_PANEL_MAX_HEIGHT,
         // padding in this context is annoying: it offsets the notion of vertical alignment.
         // children that want to be centered vertically need to have their size adjusted by 2x the padding
-        // padding: const EdgeInsets.all(10.0),
+        padding: const EdgeInsets.all(10.0),
         // Panel snapping should not be disabled because it significantly improves the user experience
         // panelSnapping: false
         borderRadius: const BorderRadius.only(topLeft: Radius.circular(25), topRight: Radius.circular(25)),
@@ -54,13 +52,6 @@ class _TripPageState extends State<TripPage> {
             color: Colors.black,
           )
         ],
-      ),
-      title: FutureBuilder(
-        future: widget.trip.cityName,
-        builder: (context, snapshot) => Text(
-          'Your trip to ${snapshot.hasData ? snapshot.data! : "..."}',
-        )
-      ),
     );
   }
 }

frontend/lib/pages/new_trip_location.dart

@@ -1,5 +1,5 @@
+import 'package:anyway/modules/new_trip_button.dart';
 import 'package:anyway/modules/new_trip_options_button.dart';
-import 'package:anyway/pages/base_page.dart';
 import 'package:flutter/material.dart';
 
 import "package:anyway/structs/trip.dart";
@@ -19,28 +19,23 @@ class _NewTripPageState extends State<NewTripPage> {
   final TextEditingController lonController = TextEditingController();
   Trip trip = Trip();
 
-
   @override
   Widget build(BuildContext context) {
     // floating search bar and map as a background
-    return BasePage(
-      mainScreen: Scaffold(
-        body: Stack(
-          children: [
-            NewTripMap(trip),
-            Padding(
-              padding: EdgeInsets.all(15),
-              child: NewTripLocationSearch(trip),
-            ),
-          ],
-        ),
-        floatingActionButton: NewTripOptionsButton(trip: trip),
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text('New Trip'),
       ),
-      title: Text("New Trip"),
-      helpTexts: [
-        "Setting the start location",
-        "To set the starting point, type a city name in the search bar. You can also navigate the map like you're used to and long press anywhere to set a starting point."
-      ],
+      body: Stack(
+        children: [
+          NewTripMap(trip),
+          Padding(
+            padding: EdgeInsets.all(15),
+            child: NewTripLocationSearch(trip),
+          ),
+        ],
+      ),
+      floatingActionButton: NewTripOptionsButton(trip: trip),
     );
   }
 }

frontend/lib/pages/new_trip_preferences.dart

@@ -1,5 +1,4 @@
 import 'package:anyway/modules/new_trip_button.dart';
-import 'package:anyway/pages/base_page.dart';
 import 'package:anyway/structs/preferences.dart';
 import 'package:anyway/structs/trip.dart';
 import 'package:flutter/cupertino.dart';
@@ -20,54 +19,41 @@ class _NewTripPreferencesPageState extends State<NewTripPreferencesPage> {
 
   @override
   Widget build(BuildContext context) {
-    return BasePage(
-      mainScreen: Scaffold(
-        body: ListView(
-          children: [
-            // Center(
-            //   child: CircleAvatar(
-            //     radius: 100,
-            //     child: Icon(Icons.person, size: 100),
-            //   )
-            // ),
-            // Padding(padding: EdgeInsets.only(top: 30)),
-            // Center(
-            //   child: FutureBuilder(
-            //     future: widget.trip.cityName,
-            //     builder: (context, snapshot) => Text(
-            //       'Your trip to ${snapshot.hasData ? snapshot.data! : "..."}',
-            //       style: TextStyle(fontSize: 24, fontWeight: FontWeight.bold)
-            //     )
-            //   )
-            // ),
+    return Scaffold(
+      body: ListView(
+        children: [
+          // Center(
+          //   child: CircleAvatar(
+          //     radius: 100,
+          //     child: Icon(Icons.person, size: 100),
+          //   )
+          // ),
+          Padding(padding: EdgeInsets.only(top: 30)),
+          Center(
+            child: FutureBuilder(
+              future: widget.trip.cityName,
+              builder: (context, snapshot) => Text(
+                'Your trip to ${snapshot.hasData ? snapshot.data! : "..."}',
+                style: TextStyle(fontSize: 24, fontWeight: FontWeight.bold)
+              )
+            )
+          ),
 
-            Center(
-              child: Padding(
-              padding: EdgeInsets.only(left: 10, right: 10, top: 20, bottom: 0),
-                child: Text('Tell us about your ideal trip.', style: TextStyle(fontSize: 18))
-              ),
+          Center(
+            child: Padding(
+            padding: EdgeInsets.only(left: 10, right: 10, top: 20, bottom: 0),
+              child: Text('Tell us about your ideal trip.', style: TextStyle(fontSize: 18))
             ),
+          ),
 
-            Divider(indent: 25, endIndent: 25, height: 50),
+          Divider(indent: 25, endIndent: 25, height: 50),
 
-            durationPicker(preferences.maxTime),
+          durationPicker(preferences.maxTime),
 
-            preferenceSliders([preferences.sightseeing, preferences.shopping, preferences.nature]),
-          ]
-        ),
-        floatingActionButton: NewTripButton(trip: widget.trip, preferences: preferences),
+          preferenceSliders([preferences.sightseeing, preferences.shopping, preferences.nature]),
+        ]
       ),
-      
-      title: FutureBuilder(
-        future: widget.trip.cityName,
-        builder: (context, snapshot) => Text(
-          'Your trip to ${snapshot.hasData ? snapshot.data! : "..."}',
-        )
-      ),
-      helpTexts: [
-        'Trip preferences',
-        'Set your preferences for this trip. These will be used to generate a custom itinerary.'
-      ],
+      floatingActionButton: NewTripButton(trip: widget.trip, preferences: preferences),
     );
   }
 

frontend/lib/pages/onboarding.dart

@@ -1,33 +1,7 @@
-import 'dart:ui';
-
-import 'package:anyway/constants.dart';
 import 'package:anyway/modules/onboarding_card.dart';
 import 'package:anyway/pages/new_trip_location.dart';
 import 'package:flutter/material.dart';
 
-const List<Widget> onboardingCards = [
-  OnboardingCard(
-    title: "Welcome to anyway!",
-    description: "Anyway helps you plan a city trip that suits your wishes.",
-    imagePath: "assets/city.svg"
-  ),
-  OnboardingCard(
-    title: "Find your way",
-    description: "Bored by churches? No problem! Hate shopping? No worries! Instead of suggesting the generic trips that bore you, anyway will try to give you recommendations that really suit you.",
-    imagePath: "assets/plan.svg"
-  ),
-  OnboardingCard(
-    title: "Change your mind",
-    description: "Feet get sore, the weather changes. Anyway understands that! Move or remove destinations, visit hidden gems along your journey, do your own thing. Anyway adapts to your spontaneous decisions.",
-    imagePath: "assets/cat.svg"
-  ),
-  OnboardingCard(
-    title: "Feeling lost?",
-    description: "Whenever you are confused or need help with the app, look out for the question mark in the top right corner. Help is just a tap away!",
-    imagePath: "assets/confused.svg"
-  ),
-];
-
 class OnboardingPage extends StatefulWidget {
   const OnboardingPage({super.key});
 
@@ -36,83 +10,37 @@ class OnboardingPage extends StatefulWidget {
 }
 
 class _OnboardingPageState extends State<OnboardingPage> {
-  final PageController _controller = PageController();
-
   @override
   Widget build(BuildContext context) {
+    final PageController _controller = PageController();
     return Scaffold(
       body: Stack(
         children: [
-          AnimatedBuilder(
-            animation: _controller,
-            builder: (context, child) {
-              return Stack(
-                children: [
-                  Container(
-                    decoration: BoxDecoration(
-                      gradient: LinearGradient(
-                        begin: Alignment.topLeft,
-                        end: Alignment.bottomRight,
-                        colors: APP_GRADIENT.colors,
-                        stops: [
-                          (_controller.hasClients ? _controller.page ?? _controller.initialPage : _controller.initialPage) / onboardingCards.length,
-                          (_controller.hasClients ? _controller.page ?? _controller.initialPage + 1 : _controller.initialPage + 1) / onboardingCards.length,
-                        ],
-                      ),
-                    ),
-                  ),
-                  BackdropFilter(
-                    filter: ImageFilter.blur(sigmaX: 100, sigmaY: 100),
-                    child: Container(
-                      color: Colors.black.withOpacity(0),
-                    ),
-                  ),
-                ],
-              );
-            },
-          ),
           PageView(
+            // horizontally scrollable list of pages
             controller: _controller,
-            children: List.generate(
-              onboardingCards.length,
-              (index) {
-                return Container(
-                  alignment: Alignment.center,
-                  child: onboardingCards[index],
-                );
-              }
-            ),
+            
+            children: [
+              OnboardingCard(index: 1, title: "Welcome to anyway!", description: "Anyway helps you plan a city trip that suits your wishes.", imagePath: "assets/city.svg"),
+              OnboardingCard(index: 2, title: "Find your way", description: "Bored by churches? No problem! Hate shopping? No worries! More than showing you the typical 'must-sees' of a city, anyway will try to give you recommendations that really suit you.", imagePath: "assets/plan.svg"),
+              OnboardingCard(index: 3, title: "Change your mind", description: "Life happens when you're busy making plans. Anyway understands that! Move or remove destinations, visit hidden gems along your journey, do your own thing. Anyway adapts to your spontaneous decisions.", imagePath: "assets/cat.svg"),
+            ],
           ),
         ],
       ),
-      floatingActionButton: FloatingActionButton.extended(
-        onPressed: () {
-          if (_controller.page == onboardingCards.length - 1) {
-            Navigator.of(context).push(
-              MaterialPageRoute(
-                builder: (context) => const NewTripPage()
-              )
-            );
-          } else {
-            _controller.nextPage(duration: Duration(milliseconds: 500), curve: Curves.ease);
-          }
-        },
-        label: AnimatedBuilder(
-          animation: _controller,
-          builder: (context, child) {
-            if ((_controller.page ?? _controller.initialPage) == onboardingCards.length - 1) {
-              return Row(
-                children: [
-                  const Text("Start planning!"),
-                  Padding(padding: const EdgeInsets.only(right: 8.0)),
-                  const Icon(Icons.map_outlined)
-                ],
+      floatingActionButton: FloatingActionButton(
+         onPressed: () {
+            if (_controller.page == 2) {
+              Navigator.of(context).push(
+                MaterialPageRoute(
+                  builder: (context) => const NewTripPage()
+                )
               );
             } else {
-              return const Icon(Icons.arrow_forward);
+              _controller.nextPage(duration: Duration(milliseconds: 500), curve: Curves.ease);
             }
-          }
-        )
+          },
+          child: Icon(Icons.arrow_forward),
       ),
     );
   }

frontend/lib/pages/settings.dart

@@ -1,6 +1,5 @@
 import 'package:anyway/constants.dart';
 import 'package:anyway/main.dart';
-import 'package:anyway/pages/base_page.dart';
 import 'package:flutter/material.dart';
 import 'package:permission_handler/permission_handler.dart';
 import 'package:shared_preferences/shared_preferences.dart';
@@ -17,37 +16,30 @@ class SettingsPage extends StatefulWidget {
 class _SettingsPageState extends State<SettingsPage> {
   @override
   Widget build(BuildContext context) {
-    return BasePage(
-      mainScreen: ListView(
-        padding: EdgeInsets.all(15),
-        children: [
-          // First a round, centered image
-          Center(
-            child: CircleAvatar(
-              radius: 75,
-              child: Icon(Icons.settings, size: 100),
-            )
-          ),
-          Center(
-            child: Text('Global settings', style: TextStyle(fontSize: 24))
-          ),
+    return ListView(
+      padding: EdgeInsets.all(15),
+      children: [
+        // First a round, centered image
+        Center(
+          child: CircleAvatar(
+            radius: 75,
+            child: Icon(Icons.settings, size: 100),
+          )
+        ),
+        Center(
+          child: Text('Global settings', style: TextStyle(fontSize: 24))
+        ),
 
-          Divider(indent: 25, endIndent: 25, height: 50),
+        Divider(indent: 25, endIndent: 25, height: 50),
 
-          darkMode(),
-          setLocationUsage(),
-          setDebugMode(),
+        darkMode(),
+        setLocationUsage(),
+        setDebugMode(),
 
-          Divider(indent: 25, endIndent: 25, height: 50),
+        Divider(indent: 25, endIndent: 25, height: 50),
 
-          privacyInfo(),
-        ]
-      ),
-      title: Text('Settings'),
-      helpTexts: [
-        'Settings',
-        'Preferences set in this page are global and will affect the entire application.'
-      ],
+        privacyInfo(),
+      ]
     );
   }
 
@@ -177,9 +169,7 @@ class _SettingsPageState extends State<SettingsPage> {
     return Center(
       child: Column(
         children: [
-          Text('AnyWay does not collect or store any of the data that is submitted via the app. The location of your trip is not stored. The location feature is only used to show your current location on the map, it is not transmitted to our servers.', textAlign: TextAlign.center),
-          Padding(padding: EdgeInsets.only(top: 3)),
-          Text('Our full privacy policy is available under:', textAlign: TextAlign.center),
+          Text('Our privacy policy is available under:'),
           
           TextButton.icon(
             icon: Icon(Icons.info),

frontend/lib/structs/landmark.dart

@@ -24,7 +24,8 @@ final class Landmark extends LinkedListEntry<Landmark>{
   // description to be shown in the overview
   final String? nameEN;
   final String? websiteURL;
-  String? imageURL; // not final because it can be patched
+  final String? wikipediaURL;
+  final String? imageURL;
   final String? description;
   final Duration? duration;
   final bool? visited;
@@ -43,6 +44,7 @@ final class Landmark extends LinkedListEntry<Landmark>{
 
     this.nameEN,
     this.websiteURL,
+    this.wikipediaURL,
     this.imageURL,
     this.description,
     this.duration,
@@ -68,6 +70,7 @@ final class Landmark extends LinkedListEntry<Landmark>{
       final isSecondary = json['is_secondary'] as bool?;
       final nameEN = json['name_en'] as String?;
       final websiteURL = json['website_url'] as String?;
+      final wikipediaURL = json['wikipedia_url'] as String?;
       final imageURL = json['image_url'] as String?;
       final description = json['description'] as String?;
       var duration = Duration(minutes: json['duration'] ?? 0) as Duration?;
@@ -82,6 +85,7 @@ final class Landmark extends LinkedListEntry<Landmark>{
         isSecondary: isSecondary,
         nameEN: nameEN,
         websiteURL: websiteURL,
+        wikipediaURL: wikipediaURL,
         imageURL: imageURL,
         description: description,
         duration: duration,
@@ -108,6 +112,7 @@ final class Landmark extends LinkedListEntry<Landmark>{
     'is_secondary': isSecondary,
     'name_en': nameEN,
     'website_url': websiteURL,
+    'wikipedia_url': wikipediaURL,
     'image_url': imageURL,
     'description': description,
     'duration': duration?.inMinutes,
@@ -125,7 +130,7 @@ class LandmarkType {
   LandmarkType({required this.name, this.icon = const Icon(Icons.location_on)}) {
     switch (name) {
       case 'sightseeing':
-        icon = const Icon(Icons.castle);
+        icon = const Icon(Icons.church);
         break;
       case 'nature':
         icon = const Icon(Icons.eco);

frontend/lib/structs/trip.dart

@@ -113,3 +113,10 @@ LinkedList<Landmark> readLandmarks(SharedPreferences prefs, String? firstUUID) {
   }
   return landmarks;
 }
+
+
+
+void removeAllTripsFromPrefs () async {
+  SharedPreferences prefs = await SharedPreferences.getInstance();
+  prefs.clear();
+}

frontend/lib/utils/fetch_trip.dart

@@ -1,6 +1,5 @@
 import "dart:convert";
 import "dart:developer";
-import "package:anyway/utils/load_landmark_image.dart";
 import 'package:dio/dio.dart';
 
 import 'package:anyway/constants.dart';
@@ -86,20 +85,6 @@ fetchTrip(
 }
 
 
-patchLandmarkImage(Landmark landmark) async {
-  // patch the landmark to include an image from an external source
-  if (landmark.imageURL == null) {
-    String? newUrl = await getImageUrlFromName(landmark.name);
-    if (newUrl != null) {
-      landmark.imageURL = newUrl;
-    }
-  } else if (landmark.imageURL!.contains("photos.app.goo.gl")) {
-    // the image is a google photos link, we should get the image behind the link
-    String? newUrl = await getImageUrlFromGooglePhotos(landmark.imageURL!);
-    // also set the new url if it is null
-    landmark.imageURL = newUrl; 
-  }
-}
 
 Future<(Landmark, String?)> fetchLandmark(String uuid) async {
   final response = await dio.get(
@@ -116,7 +101,5 @@ Future<(Landmark, String?)> fetchLandmark(String uuid) async {
   log(response.data.toString());
   Map<String, dynamic> json = response.data;
   String? nextUUID = json["next_uuid"];
-  Landmark landmark = Landmark.fromJson(json);
-  patchLandmarkImage(landmark);
-  return (landmark, nextUUID);
+  return (Landmark.fromJson(json), nextUUID);
 }

frontend/lib/utils/get_first_page.dart

@@ -1,41 +0,0 @@
-import 'package:anyway/pages/current_trip.dart';
-import 'package:anyway/pages/onboarding.dart';
-import 'package:anyway/structs/trip.dart';
-import 'package:anyway/utils/load_trips.dart';
-import 'package:flutter/material.dart';
-
-Widget getFirstPage() {
-  SavedTrips trips = SavedTrips();
-  trips.loadTrips();
-
-  return ListenableBuilder(
-    listenable: trips,
-    builder: (BuildContext context, Widget? child) {
-      List<Trip> items = trips.trips;
-      if (items.isNotEmpty) {
-        return TripPage(trip: items[0]);
-      } else {
-        return OnboardingPage();
-      }
-    }
-  );
-  // Future<List<Trip>> trips = loadTrips();
-  // // test if there are any active trips
-  // // if there are, return the trip list
-  // // if there are not, return the onboarding page
-  // return FutureBuilder(
-  //   future: trips,
-  //   builder: (context, snapshot) {
-  //     if (snapshot.hasData) {
-  //       List<Trip> availableTrips = snapshot.data!;
-  //       if (availableTrips.isNotEmpty) {
-  //         return TripPage(trip: availableTrips[0]);
-  //       } else {
-  //         return OnboardingPage();
-  //       }
-  //     } else {
-  //       return CircularProgressIndicator();
-  //     }
-  //   }
-  // );
-}

frontend/lib/utils/load_landmark_image.dart

@@ -1,71 +0,0 @@
-import 'dart:developer';
-
-import 'package:dio/dio.dart';
-import 'package:fuzzywuzzy/fuzzywuzzy.dart';
-import 'dart:convert';
-
-import 'package:fuzzywuzzy/model/extracted_result.dart';
-
-const String baseUrl = "https://en.wikipedia.org/w/api.php";
-final Dio dio = Dio();
-
-Future<int?> bestPageMatch(String title) async {
-    final response = await dio.get(baseUrl, queryParameters: {
-        "action": "query",
-        "format": "json",
-        "list": "prefixsearch",
-        "pssearch": title,
-    });
-
-    final data = jsonDecode(response.toString());
-    log(data.toString());
-    final List<dynamic> results = data["query"]["prefixsearch"] ?? {};
-    final Map<String, int> titlesAndIds = {
-        for (var d in results) d["title"]: d["pageid"]
-    };
-    if (titlesAndIds.isEmpty) {
-        log("No pages found for $title");
-        return null;
-    }
-
-    // after the empty check, we can safely assume that there is a best match
-    final ExtractedResult<String> bestMatch = extractOne(
-      query: title,
-      choices: titlesAndIds.keys.toList(),
-      cutoff: 70,
-    );
-    return titlesAndIds[bestMatch.choice];
-}
-
-Future<String?> getImageUrl(int pageId) async {
-    final response = await dio.get(baseUrl, queryParameters: {
-        "action": "query",
-        "format": "json",
-        "prop": "pageimages",
-        "pageids": pageId,
-        "pithumbsize": 500,
-    });
-
-    final data = jsonDecode(response.toString());
-    final pageData = data["query"]["pages"][pageId.toString()];
-    return pageData["thumbnail"]?["source"];
-}
-
-Future<String?> getImageUrlFromName(String title) async {
-    int? pageId = await bestPageMatch(title);
-    if (pageId == null) {
-        return null;
-    }
-    return await getImageUrl(pageId);
-}
-
-
-Future<String?> getImageUrlFromGooglePhotos(String url) async {
-    // this is a very simple implementation that just gets the image behind the link
-    // it is not guaranteed to work for all google photos links
-    final response = await dio.get(url);
-    final data = response.toString();
-    final int start = data.indexOf("https://lh3.googleusercontent.com");
-    final int end = data.indexOf('"', start);
-    return data.substring(start, end);
-}

frontend/lib/utils/load_trips.dart

@@ -1,39 +1,19 @@
+import 'dart:collection';
+
 import 'package:anyway/structs/trip.dart';
+import 'package:anyway/structs/landmark.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
-import 'package:flutter/foundation.dart';
+Future<List<Trip>> loadTrips() async {
+  SharedPreferences prefs = await SharedPreferences.getInstance();
 
-class SavedTrips extends ChangeNotifier {
-  List<Trip> _trips = [];
-
-  List<Trip> get trips => _trips;
-
-  void loadTrips() async {
-    SharedPreferences prefs = await SharedPreferences.getInstance();
-
-    List<Trip> trips = [];
-    Set<String> keys = prefs.getKeys();
-    for (String key in keys) {
-      if (key.startsWith('trip_')) {
-        String uuid = key.replaceFirst('trip_', '');
-        trips.add(Trip.fromPrefs(prefs, uuid));
-      }
+  List<Trip> trips = [];
+  Set<String> keys = prefs.getKeys();
+  for (String key in keys) {
+    if (key.startsWith('trip_')) {
+      String uuid = key.replaceFirst('trip_', '');
+      trips.add(Trip.fromPrefs(prefs, uuid));
     }
-    _trips = trips;
-    notifyListeners();
-  }
-
-  void addTrip(Trip trip) async {
-    SharedPreferences prefs = await SharedPreferences.getInstance();
-    trip.toPrefs(prefs);
-    _trips.add(trip);
-    notifyListeners();
-  }
-
-  void clearTrips () async {
-    SharedPreferences prefs = await SharedPreferences.getInstance();
-    prefs.clear();
-    _trips = [];
-    notifyListeners();
   }
+  return trips;
 }

frontend/pubspec.lock

@@ -232,14 +232,6 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.0"
-  fuzzywuzzy:
-    dependency: "direct main"
-    description:
-      name: fuzzywuzzy
-      sha256: "3004379ffd6e7f476a0c2091f38f16588dc45f67de7adf7c41aa85dec06b432c"
-      url: "https://pub.dev"
-    source: hosted
-    version: "1.2.0"
   geocoding:
     dependency: "direct main"
     description:

frontend/pubspec.yaml

@@ -51,7 +51,6 @@ dependencies:
   flutter_launcher_icons: ^0.13.1
   permission_handler: ^11.3.1
   geolocator: ^13.0.1
-  fuzzywuzzy: ^1.2.0
 
 dev_dependencies:
   flutter_test:

frontend/test/widget_test.dart

@@ -0,0 +1,30 @@
+// This is a basic Flutter widget test.
+//
+// To perform an interaction with a widget in your test, use the WidgetTester
+// utility in the flutter_test package. For example, you can send tap and scroll
+// gestures. You can also use WidgetTester to find child widgets in the widget
+// tree, read text, and verify that the values of widget properties are correct.
+
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+// import 'package:anyway/main.dart';
+import 'package:anyway/layout.dart';
+
+void main() {
+  testWidgets('Counter increments smoke test', (WidgetTester tester) async {
+    // Build our app and trigger a frame.
+    await tester.pumpWidget(BasePage(mainScreen: "map",));
+
+    // Verfiy that the title is displayed
+    expect(find.text('City Nav'), findsOneWidget);
+
+    // Tap the '+' icon and trigger a frame.
+    await tester.tap(find.byIcon(Icons.add));
+    await tester.pump();
+
+    // Verify that our counter has incremented.
+    expect(find.text('0'), findsNothing);
+    expect(find.text('1'), findsOneWidget);
+  });
+}

testing_image_query.py

@@ -1,50 +0,0 @@
-import httpx
-import json
-
-base_url = "https://en.wikipedia.org/w/api.php"
-
-def best_page_match(title) -> int:
-    params = {
-        "action": "query",
-        "format": "json",
-        "list": "prefixsearch",
-        "pssearch": title,
-    }
-    response = httpx.get(base_url, params=params)
-    data = response.json()
-    data = data.get("query", {}).get("prefixsearch", [])
-    titles_and_ids = {d["title"]: d["pageid"] for d in data}
-
-    for t in titles_and_ids:
-        if title.lower() == t.lower():
-            print("Matched")
-            return titles_and_ids[t]
-
-def get_image_url(page_id) -> str:
-    # https://en.wikipedia.org/w/api.php?action=query&titles=K%C3%B6lner%20Dom&prop=imageinfo&iiprop=url&format=json
-    params = {
-        "action": "query",
-        "format": "json",
-        "prop": "pageimages",
-        "pageids": page_id,
-        "pithumbsize": 500,
-    }
-    response = httpx.get(base_url, params=params)
-    data = response.json()
-    data = data.get("query", {}).get("pages", {})
-    data = data.get(str(page_id), {})
-    return data.get("thumbnail", {}).get("source")
-
-def get_image_url_from_title(title) -> str:
-    page_id = best_page_match(title)
-    if page_id is None:
-        return None
-    return get_image_url(page_id)
-
-
-print(get_image_url_from_title("kölner dom"))
-print(get_image_url_from_title("grossmünster"))
-print(get_image_url_from_title("eiffel tower"))
-print(get_image_url_from_title("taj mahal"))
-print(get_image_url_from_title("big ben"))
-