django_example_ynh/README.md

54 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2022-08-12 18:18:29 +02:00
<!--
2024-03-29 07:00:18 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2022-08-12 18:18:29 +02:00
It shall NOT be edited by hand.
-->
2020-12-23 19:53:13 +01:00
2022-08-12 18:18:29 +02:00
# Django Example for YunoHost
2020-12-23 19:53:13 +01:00
2023-04-12 20:14:41 +02:00
[![Integration level](https://dash.yunohost.org/integration/django_example.svg)](https://dash.yunohost.org/appci/app/django_example) ![Working status](https://ci-apps.yunohost.org/ci/badges/django_example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/django_example.maintain.svg)
[![Install Django Example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django_example)
2020-12-29 15:08:56 +01:00
2024-05-20 16:22:59 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2020-12-29 15:08:56 +01:00
2024-03-29 07:00:18 +01:00
> *This package allows you to install Django Example 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-29 15:08:56 +01:00
2022-08-12 18:18:29 +02:00
## Overview
2020-12-29 15:08:56 +01:00
2022-12-21 20:11:06 +01:00
[![tests](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/tests.yml)
2023-11-26 15:55:38 +01:00
[![codecov](https://codecov.io/github/jedie/django_example_ynh/branch/main/graph/badge.svg)](https://app.codecov.io/github/jedie/django_example_ynh)
2022-12-21 20:11:06 +01:00
[![django_example_ynh @ PyPi](https://img.shields.io/pypi/v/django_example_ynh?label=django_example_ynh%20%40%20PyPi)](https://pypi.org/project/django_example_ynh/)
[![Python Versions](https://img.shields.io/pypi/pyversions/django_example_ynh)](https://github.com/YunoHost-Apps/django_example_ynh/blob/main/pyproject.toml)
2023-11-26 15:55:38 +01:00
[![License GPL-3.0-or-later](https://img.shields.io/pypi/l/django_example_ynh)](https://github.com/YunoHost-Apps/django_example_ynh/blob/main/LICENSE)
2022-08-14 17:50:29 +02:00
2023-11-26 15:55:38 +01:00
Demo YunoHost Application to demonstrate the integration of a Django project under YunoHost.
2022-08-14 17:50:29 +02:00
Pull requests welcome ;)
2023-11-26 15:55:38 +01:00
This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration)
2020-12-29 15:08:56 +01:00
2023-11-26 15:55:38 +01:00
**Shipped version:** 0.2.0~ynh3
2022-08-12 18:18:29 +02:00
## Documentation and resources
2020-12-29 15:08:56 +01:00
2024-03-29 07:00:18 +01:00
- Official user documentation: <https://github.com/jedie/django-example>
- Official admin documentation: <https://github.com/YunoHost-Apps/django_example_ynh>
- Upstream app code repository: <https://github.com/YunoHost-Apps/django_example_ynh>
- YunoHost Store: <https://apps.yunohost.org/app/django_example>
- Report a bug: <https://github.com/YunoHost-Apps/django_example_ynh/issues>
2020-12-23 19:53:13 +01:00
2022-08-12 18:18:29 +02:00
## Developer info
2020-12-23 19:53:13 +01:00
2024-03-29 07:00:18 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/django_example_ynh/tree/testing).
2020-12-23 19:53:13 +01:00
2024-03-29 07:00:18 +01:00
To try the `testing` branch, please proceed like that:
2020-12-23 19:53:13 +01:00
2024-03-29 07:00:18 +01:00
```bash
2023-04-12 20:14:41 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/django_example_ynh/tree/testing --debug
2020-12-23 19:53:13 +01:00
or
2023-04-12 20:14:41 +02:00
sudo yunohost app upgrade django_example -u https://github.com/YunoHost-Apps/django_example_ynh/tree/testing --debug
2020-12-23 19:53:13 +01:00
```
2022-08-12 18:18:29 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>