django_example_ynh/README.md

50 lines
2.7 KiB
Markdown
Raw Normal View History

2022-08-12 18:18:29 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2020-12-23 19:53:13 +01:00
<<<<<<< HEAD
2021-10-10 16:12:25 +02:00
[![pytest](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/pytest.yml/badge.svg)](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/package_linter.yml)
Demo [YunoHost Application](https://install-app.yunohost.org/?app=django_example_ynh) to demonstrate the integration of a Django project under YunoHost.
=======
2022-08-12 18:18:29 +02:00
# Django Example for YunoHost
>>>>>>> d2c60e4308ed0eb7fc2ee758ccdfeb07bb78450b
2020-12-23 19:53:13 +01:00
2022-08-12 18:18:29 +02:00
[![Integration level](https://dash.yunohost.org/integration/django_example_ynh.svg)](https://dash.yunohost.org/appci/app/django_example_ynh) ![Working status](https://ci-apps.yunohost.org/ci/badges/django_example_ynh.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/django_example_ynh.maintain.svg)
[![Install Django Example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django_example_ynh)
2020-12-29 15:08:56 +01:00
2022-08-12 18:18:29 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2020-12-29 15:08:56 +01:00
2022-08-12 18:18:29 +02: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-08-12 18:18:29 +02:00
Demo YunoHost Application to demonstrate the integration of a Django project under YunoHost.
2020-12-29 15:08:56 +01:00
2022-08-12 18:18:29 +02:00
**Shipped version:** v0.3.0~ynh1
2020-12-29 15:08:56 +01:00
2022-08-12 18:18:29 +02:00
## Documentation and resources
2020-12-29 15:08:56 +01:00
2022-08-12 18:18:29 +02:00
* Official app website: <https://github.com/YunoHost-Apps/django_yunohost_integration>
* Official user documentation: <https://github.com/YunoHost-Apps/django_yunohost_integration>
* Official admin documentation: <https://github.com/YunoHost-Apps/django_yunohost_integration>
* Upstream app code repository: <https://github.com/YunoHost-Apps/django_yunohost_integration>
* YunoHost documentation for this app: <https://yunohost.org/app_django_example_ynh>
* Report a bug: <https://github.com/YunoHost-Apps/django_example_ynh_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
2022-08-12 18:18:29 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/django_example_ynh_ynh/tree/testing).
2020-12-23 19:53:13 +01:00
2022-08-12 18:18:29 +02:00
To try the testing branch, please proceed like that.
2020-12-23 19:53:13 +01:00
2022-08-12 18:18:29 +02:00
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/django_example_ynh_ynh/tree/testing --debug
2020-12-23 19:53:13 +01:00
or
2022-08-12 18:18:29 +02:00
sudo yunohost app upgrade django_example_ynh -u https://github.com/YunoHost-Apps/django_example_ynh_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>