This is a server-side service that proxies requests to any [DocC](https://www.swift.org/documentation/docc/) archive available at a certain folder in the local machine.
This application was written with the [Swift programming language](https://www.swift.org), and it was built on top of the [Hummingbird](https://wwww.hummingbird.codes) framework.
This application requires that the [Swift v6](https://www.swift.org/blog/announcing-swift-6/) compiler is installed in the local machine. In principle, the service should be able to run on *MacOS*, *Linux*, and even *iOS* platforms.
With these pieces of software installed, then it would be certainly possible for this service to be downloaded (or cloned) and installed locally.
In case it is desirable to use the [Docker](https://www.docker.com) container solution, then it is also recommandable to have this software installed into the local machine, as the building tool of the service supports it.
This service depends on the following [SPM](https://www.swift.org/documentation/package-manager/) libraries and plugins to be compiled and built, before installing it locally:
If a `permission issue` issue is raised when installing the built executable into the system binaries folder, means the user used have no *admin* and/or *root* priviledges. In that case, the developer should copy/install the built executable manually to a custom location in the file system.
```bash
# Copy the built executable into a non-protected folder.
$ cp ./build/release/doxy /path/to/some/folder
# Change the current folder to the non-protected folder.
To use this service, please do execute the following commands in the prompt of the **Terminal** command-line app in the local system:
```bash
# Execute the service with a path to DocC archives in the local file system.
$ doxy --archive-path path/to/docc/archives
```
The other input parameters have defined some default values already. In case it is required to use other values than those defined by default, please do refer to the service's documentation also in the prompt of the **Terminal** command-line app:
```bash
# List all the input parameters supported by the service.
For more detailed explanations about any of the types on either the *App* and the *Library* targets, which together compose the service, then it is possible to generate the respective [DocC](https://www.swift.org/documentation/docc/) archives inside a provided archives folder in the local file system by executing the following command in the prompt of the **Terminal** command-line app:
Given this service might also provide other useful *development/management/container*, functionalities, please refer to the available targets provided by the `Makefile` by running the following command in the prompt of the **Terminal** command-line app:
