Hello everyone!
We are excited to announce that our repository is moving to a new home! Starting today, we will be migrating from GitHub to GitLab to better serve our community and improve our development workflow.
You can find our new repository at:
- Contributors: Please update your remote URLs to point to the new GitLab repository.
- Users: If you have cloned the repository, make sure to update your local clone to the new URL.
- Issues and Pull Requests: We will be transferring open issues and pull requests to the new repository. Please bear with us during this transition.
GitLab offers a comprehensive suite of tools for version control, issue tracking, and CI/CD, all integrated into a single platform. This move will help us streamline our development process and provide a better experience for our contributors and users.
We appreciate your support and understanding during this transition. If you have any questions or run into issues, please don't hesitate to reach out.
Happy coding!
Please note that the GitHub repository will be archived soon. Make sure to update your bookmarks and clone URLs accordingly.
10K Step Path Generator is a fitness app that helps users achieve their daily walking goals by generating personalized looped walking routes. Using OpenRouteService API, it calculates paths tailored to your step length and visualizes them on an interactive Leaflet map. With support for GPX downloads, offline use, and persistent local storage, this app makes fitness simple and fun!
- Create looped walking paths to meet daily step goals.
- Leverages OpenRouteService API for optimized paths.
- Step-length calculator based on height and gender.
- Visualize routes on an interactive Leaflet map.
- Save routes in a Dexie database (IndexedDB) for persistence.
- Download GPX files for offline navigation.
- Customizable routes and user preferences.
- Bun: An ultra-fast all-in-one JavaScript runtime used for developing this application.
- Mise: An dev-tools manager for nearly everything.
- OpenRouteService API: For route generation and optimization.
- Leaflet.js: For map visualization and interactivity.
- Dexie.js: For storing routes and persistent data in IndexedDB.
- React & Next.js: For building the app’s interactive user interface.
-
Clone the repository:
git clone https://gitlab.com/itishermann/10k-steps.git cd 10k-steps -
Ensure Bun is installed.
Check with:bun -v
If not installed, install the version 1.2.0 or higher with mise:
mise trust mise install bun
-
Install dependencies using Bun:
bun install
-
Start the development server:
bun dev
-
Open your browser and navigate to
http://localhost:3000to view your app.
- Input your height and gender to calculate your step length.
- Set your desired step goal (default: 10,000 steps).
- Generate a personalized walking route based on your preferences.
- Preview the route on the map.
- Save the route to local storage or download the GPX file for offline navigation.
- Hit the path and start walking toward your fitness goals!
- Step Length Calculation: The app calculates your individual step length based on height and gender to optimize path planning.
- Path Generation: Uses the OpenRouteService API to calculate looped walking paths that match your desired step count.
- Visualization: Routes are displayed on a Leaflet.js map, allowing you to easily preview the distance and terrain.
- Storage: Routes are stored in an IndexedDB-powered Dexie database for future retrieval.
- GPX File Export: Save routes as GPX files for offline use on compatible fitness trackers and apps.
Contributions are welcome! To contribute:
- Fork this repository.
- Create a new branch (
git checkout -b your-feature-branch). - Make your changes and commit (
git commit -m "Add new feature"). - Push to the branch (
git push origin your-feature-branch) and open a pull request.
This project is open-source and available under the MIT License.
Feel free to customize this file further based on your preferences or additional features you might add! Let me know if you'd like specific sections expanded. 😊