mirror of
https://github.com/YunoHost-Apps/scovie_ynh.git
synced 2024-09-03 20:16:29 +02:00
update README.md, urls.py and DISCLAIMER.md
This commit is contained in:
André Théo LAURET
parent
4f0086c7da
commit
60ef484050
3 changed files with 21 additions and 61 deletions
71
README.md
71
README.md
|
|
@ -1,40 +1,29 @@
|
|||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# Django Example for YunoHost
|
||||
# Scovie: Digital Signage for High Schools
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/scovie_ynh)  
|
||||
[](https://install-app.yunohost.org/?app=scovie_ynh)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Django Example quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install Scovie 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.*
|
||||
|
||||
## Overview
|
||||
|
||||
[](https://github.com/eldertek/scovie_ynh/actions/workflows/pytest.yml) [](https://github.com/eldertek/scovie_ynh/actions/workflows/package_linter.yml)
|
||||
|
||||
Demo [YunoHost Application](https://install-app.yunohost.org/?app=scovie_ynh) to demonstrate the integration of a [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/) project under YunoHost using [django_yunohost_integration](https://github.com/eldertek/django_yunohost_integration).
|
||||
|
||||
To demonstrate the functionality the small [scovie](https://github.com/eldertek/scovie) app will be installed.
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/scovie_ynh)  
|
||||
[](https://install-app.yunohost.org/?app=scovie_ynh)
|
||||
[Scovie](https://github.com/eldertek/scovie) is an open-source digital signage system for high schools, built using Python and Django. It provides an easy-to-use interface for administrators to upload and manage multimedia content, which is then displayed on screens throughout the school.
|
||||
|
||||
You can try the [demo](https://scovie.eclipse-technology.eu) here.
|
||||
|
||||
Pull requests welcome ;)
|
||||
|
||||
|
||||
**Shipped version:** 0.5.0rc1~ynh1
|
||||
**Shipped version:** 0.0.5
|
||||
## Disclaimers / important information
|
||||
|
||||
## local test
|
||||
|
||||
For quicker developing of scovie_ynh in the context of YunoHost app,
|
||||
it's possible to run the Django developer server with the settings
|
||||
it's possible to run the Django development server with the settings
|
||||
and urls made for YunoHost installation.
|
||||
|
||||
e.g.:
|
||||
|
|
@ -63,46 +52,26 @@ Notes:
|
|||
|
||||
* SQlite database will be used
|
||||
* A super user with username `test` and password `test` is created
|
||||
* The page is available under `http://127.0.0.1:8000/app_path/`
|
||||
* The page is available under `http://127.0.0.1:8000/`
|
||||
|
||||
|
||||
## history
|
||||
|
||||
* [compare v0.1.5...master](https://github.com/eldertek/scovie_ynh/compare/v0.2.0...master) **dev**
|
||||
* tbc
|
||||
* [v0.2.0 - 15.09.2021](https://github.com/eldertek/scovie_ynh/compare/v0.1.5...v0.2.0)
|
||||
* rename/split `scovie_ynh` into:
|
||||
* [django_yunohost_integration](https://github.com/jedie/django_yunohost_integration) - Python package with the glue code to integrate a Django project with YunoHost
|
||||
* [scovie_ynh](https://github.com/eldertek/scovie_ynh) - Demo YunoHost App to demonstrate the integration of a Django project under YunoHost
|
||||
* [v0.1.5 - 19.01.2021](https://github.com/eldertek/scovie_ynh/compare/v0.1.4...v0.1.5)
|
||||
* Make some deps `gunicorn`, `psycopg2-binary`, `django-redis`, `django-axes` optional
|
||||
* [v0.1.4 - 08.01.2021](https://github.com/eldertek/scovie_ynh/compare/v0.1.3...v0.1.4)
|
||||
* Bugfix [CSRF verification failed on POST requests #7](https://github.com/eldertek/scovie_ynh/issues/7)
|
||||
* [v0.1.3 - 08.01.2021](https://github.com/eldertek/scovie_ynh/compare/v0.1.2...v0.1.3)
|
||||
* set "DEBUG = True" in local_test (so static files are served and auth works)
|
||||
* Bugfixes and cleanups
|
||||
* [v0.1.2 - 29.12.2020](https://github.com/eldertek/scovie_ynh/compare/v0.1.1...v0.1.2)
|
||||
* Bugfixes
|
||||
* [v0.1.1 - 29.12.2020](https://github.com/eldertek/scovie_ynh/compare/v0.1.0...v0.1.1)
|
||||
* Refactor "create_superuser" to a manage command, useable via "scovie_ynh" in `INSTALLED_APPS`
|
||||
* Generate "conf/requirements.txt" and use this file for install
|
||||
* rename own settings and urls (in `/conf/`)
|
||||
* [v0.1.0 - 28.12.2020](https://github.com/eldertek/scovie_ynh/compare/f578f14...v0.1.0)
|
||||
* [v0.0.5 - 27.05.2023](https://github.com/eldertek/scovie_ynh/compare/4b0275e7f75d199dca8a1e97c26dc8568c31cb52...4f0086c7da6123f3f8b05c4001f9109891e6bd9f)
|
||||
* first working state
|
||||
* [23.12.2020](https://github.com/eldertek/scovie_ynh/commit/f578f144a3a6d11d7044597c37d550d29c247773)
|
||||
* [26.05.2023](https://github.com/eldertek/scovie_ynh/commit/4b0275e7f75d199dca8a1e97c26dc8568c31cb52)
|
||||
* init the project
|
||||
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug about this package: https://github.com/eldertek/scovie_ynh
|
||||
* Report a bug about this package: https://github.com/eldertek/scovie_ynh/issues
|
||||
* YunoHost website: https://yunohost.org/
|
||||
* PyPi package: https://pypi.org/project/django-ynh/
|
||||
* PyPi package: https://pypi.org/project/scovie/
|
||||
|
||||
These projects used `scovie_ynh`:
|
||||
|
||||
* https://github.com/eldertek/scovie_ynh
|
||||
* https://github.com/eldertek/django-for-runners_ynh
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -186,23 +155,23 @@ root@yunohost:~# journalctl --unit=scovie_ynh --follow
|
|||
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: <https://github.com/eldertek/scovie_ynh>
|
||||
* Official user documentation: <https://github.com/eldertek/scovie_ynh>
|
||||
* Official admin documentation: <https://github.com/eldertek/scovie_ynh>
|
||||
* Upstream app code repository: <https://github.com/eldertek/scovie_ynh>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_scovie_ynh>
|
||||
* Report a bug: <https://github.com/eldertek/scovie_ynh_ynh/issues>
|
||||
* Official demo website: <https://scovie.eclipse-technology.eu>
|
||||
* Official user documentation: <https://github.com/eldertek/scovie>
|
||||
* Official admin documentation: <https://github.com/eldertek/scovie>
|
||||
* Upstream app code repository: <https://github.com/eldertek/scovie>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/scovie>
|
||||
* Report a bug: <https://github.com/eldertek/scovie_ynh/issues>
|
||||
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/eldertek/scovie_ynh_ynh/tree/testing).
|
||||
Please send your pull request to the [testing branch](https://github.com/eldertek/scovie_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/eldertek/scovie_ynh_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/eldertek/scovie_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade scovie_ynh -u https://github.com/eldertek/scovie_ynh_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade scovie_ynh -u https://github.com/eldertek/scovie_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,5 @@
|
|||
"""
|
||||
urls.py
|
||||
~~~~~~~
|
||||
|
||||
Look at real examples, here:
|
||||
|
||||
* https://github.com/eldertek/django-fritzconnection_ynh/blob/master/conf/urls.py
|
||||
* https://github.com/eldertek/django-for-runners_ynh/blob/testing/conf/urls.py
|
||||
* https://github.com/eldertek/pyinventory_ynh/blob/testing/conf/urls.py
|
||||
|
||||
"""
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -68,8 +68,7 @@ Notes:
|
|||
|
||||
These projects used `scovie_ynh`:
|
||||
|
||||
* https://github.com/eldertek/scovie_ynh
|
||||
* https://github.com/eldertek/django-for-runners_ynh
|
||||
* https://github.com/eldertek/scovie
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue