django-for-runners_ynh/README.md

61 lines
3.4 KiB
Markdown
Raw Normal View History

2022-04-15 16:59:37 +02:00
<!--
2024-03-29 07:00:09 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2022-04-15 16:59:37 +02:00
It shall NOT be edited by hand.
-->
2020-12-12 19:37:20 +01:00
2022-04-15 16:59:37 +02:00
# django-for-runners for YunoHost
2021-10-10 14:35:06 +02:00
2023-04-02 20:42:29 +02:00
[![Integration level](https://dash.yunohost.org/integration/django-for-runners.svg)](https://dash.yunohost.org/appci/app/django-for-runners) ![Working status](https://ci-apps.yunohost.org/ci/badges/django-for-runners.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/django-for-runners.maintain.svg)
2021-10-10 14:35:06 +02:00
[![Install django-for-runners with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners)
2020-12-12 19:37:20 +01:00
2024-05-13 21:04:05 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2022-04-15 16:59:37 +02:00
2024-03-29 07:00:09 +01:00
> *This package allows you to install django-for-runners quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
2020-12-12 19:37:20 +01:00
## Overview
2023-11-26 21:01:35 +01:00
[![tests](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml)
[![codecov](https://codecov.io/github/jedie/for_runners_ynh/branch/main/graph/badge.svg)](https://app.codecov.io/github/jedie/for_runners_ynh)
[![for_runners_ynh @ PyPi](https://img.shields.io/pypi/v/for_runners_ynh?label=for_runners_ynh%20%40%20PyPi)](https://pypi.org/project/for_runners_ynh/)
[![Python Versions](https://img.shields.io/pypi/pyversions/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/pyproject.toml)
[![License GPL-3.0-or-later](https://img.shields.io/pypi/l/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/LICENSE)
2021-10-10 14:35:06 +02:00
[django-for-runners](https://github.com/jedie/django-for-runners) is a libre web-based management for your GPX tracks of your running (or other sports activity). Used [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/).
2022-04-15 16:59:37 +02:00
Pull requests welcome ;)
2020-12-12 19:37:20 +01:00
2022-04-15 16:59:37 +02:00
This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration)
2020-12-12 19:37:20 +01:00
2021-10-10 14:35:06 +02:00
More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-runners](https://github.com/jedie/jedie.github.io/tree/master/screenshots/django-for-runners/README.creole)
2023-11-09 20:46:36 +01:00
**Shipped version:** 0.17.4~ynh1
2021-10-10 14:35:06 +02:00
2022-04-15 16:59:37 +02:00
## Screenshots
2021-10-10 14:35:06 +02:00
2022-09-18 17:40:22 +02:00
![Screenshot of django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png)
2024-06-23 14:30:06 +02:00
![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png)
2024-06-23 14:30:16 +02:00
![Screenshot of django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png)
2021-10-10 14:35:06 +02:00
2022-04-15 16:59:37 +02:00
## Documentation and resources
2024-05-14 15:26:32 +02:00
- Upstream app code repository: <https://github.com/jedie/django-for-runners>
2024-05-13 21:04:05 +02:00
- YunoHost Store: <https://apps.yunohost.org/app/django-for-runners>
- Report a bug: <https://github.com/YunoHost-Apps/django-for-runners_ynh/issues>
2022-04-15 16:59:37 +02:00
## Developer info
2024-03-29 07:00:09 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing).
2022-04-15 16:59:37 +02:00
2024-03-29 07:00:09 +01:00
To try the `testing` branch, please proceed like that:
2022-09-18 17:40:22 +02:00
2024-03-29 07:00:09 +01:00
```bash
2022-04-15 16:59:37 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug
or
sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug
```
2024-05-14 15:26:32 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>