Table of Contents

1. About The Project
2. Built With
3. Getting Started
     * Prerequisites
     * Installation
4. Usage
5. Roadmap
6. Contributing
7. License
8. Acknowledgments

About the Project

HLoc is a Java project that aims to replicate or work similarly to the Wikiloc platform for geolocation, routes, and outdoor activity tracking.
The idea is to allow users to record, view, and manage routes, possibly with map and geolocation support.

Features

• Route management (create, view, edit)
• Interface (or codebase) in Java
• Modular design for future expansion

Built With

This project was built using the following main technologies:

• Java (version defined in pom.xml)
• Maven as the build system
• [Optional] External libraries for geolocation/maps if implemented later
• Standard directory structure: src/main/java, pom.xml, etc. (github.com)

Getting Started

Prerequisites

• Java JDK installed (21+)
• Maven installed (or use the included mvnw)
• Git to clone the repository

Installation

1. Clone the repository:

git clone https://github.com/JMF-Alex/HLoc.git

2. Enter the project directory:

cd HLoc

3. (Opcional) Use the Maven wrapper:

./mvnw clean install

or if you use globally installed Maven:

mvn clean install

4. Once compiled, you can run the application from your IDE or command line.

Usage

You can run the application with:

java -jar target/HLoc‑1.0.0.jar

From the interface you can:

• View saved routes
• Import previously saved routes
• Edit or delete existing routes

Roadmap

• Implement graphical user interface (GUI)
• Add support for export to GPX/KML format
• Integrate map API (e.g. OpenStreetMap)
• Add user authentication and remote storage

Contributing

Contributions are welcome.
Please follow these steps:

1. Fork the project
2. Create your feature branch (git checkout -b feature/MyFeature)
3. Commit your changes with a descriptive message (git commit -m "Add some feature")
4. Push to your branch (git push origin feature/MyFeature)
5. Open a Pull Request
   Additionally, before developing a new feature, open an issue so we can discuss it.

License

Distributed under the MIT License. See the LICENSE file for more details.

Acknowledgments

• Original template by Othneil Drew: Best‑README‑Template (github.com)