Welcome to the Local Maps repository! This project is a self-hosted maps application that requires no internet connection. With Local Maps, you can navigate and explore your surroundings using offline maps. This README will guide you through the features, installation, usage, and contributions to the project.
- Offline Navigation: Access maps and directions without an internet connection.
- Vector Tiles: Utilize vector tiles for smooth and fast rendering.
- Routing: Get accurate routing information with GraphHopper.
- OpenStreetMap Integration: Leverage OpenStreetMap data for comprehensive mapping.
- Search Functionality: Use Photon for efficient address searching.
- Customizable: Tailor the application to fit your specific needs.
To get started with Local Maps, follow these steps:
-
Download the latest release from the Releases page. You need to download and execute the file.
-
Extract the files from the downloaded archive.
-
Run the application using your terminal or command prompt.
Make sure you have the necessary dependencies installed. Check the documentation for specific requirements based on your operating system.
After installation, you can start using Local Maps. Here’s how:
-
Open the application: Launch the Local Maps application from your terminal or desktop.
-
Load your map data: You can load map data from OpenStreetMap or other sources. Ensure you have the necessary files in the correct format.
-
Navigate: Use the navigation feature to find your way around. Input your starting point and destination, and the app will provide directions.
-
Search for locations: Use the search bar to find specific addresses or points of interest.
-
Customize settings: Explore the settings menu to adjust preferences such as map styles and routing options.
Local Maps utilizes several powerful technologies:
- GraphHopper: For efficient routing and navigation.
- OpenStreetMap: Provides the base map data.
- Photon: For search functionality.
- Planetiler: For creating vector tiles from OpenStreetMap data.
- HTML/CSS/JavaScript: For the web interface.
We welcome contributions to Local Maps! If you would like to contribute, please follow these steps:
-
Fork the repository: Click the "Fork" button at the top right of the page.
-
Clone your fork: Use
git cloneto clone your fork to your local machine. -
Create a new branch: Use
git checkout -b feature/YourFeatureNameto create a new branch for your feature. -
Make changes: Implement your changes and test them thoroughly.
-
Commit your changes: Use
git commit -m "Add your message here"to commit your changes. -
Push to your fork: Use
git push origin feature/YourFeatureNameto push your changes. -
Create a pull request: Go to the original repository and create a pull request.
Your contributions help improve Local Maps for everyone!
This project is licensed under the MIT License. See the LICENSE file for details.
For questions or feedback, feel free to reach out:
- Email: your-email@example.com
- GitHub: AsifThunder
To keep up with the latest updates and releases, visit our Releases page. You need to download and execute the file to get the latest features and fixes.
We would like to thank the developers and contributors of the libraries and tools we use in this project:
- GraphHopper: For their excellent routing engine.
- OpenStreetMap: For providing free map data.
- Photon: For search capabilities.
- Planetiler: For vector tile generation.
Thank you for your interest in Local Maps! We hope you find it useful for your offline navigation needs.