YunoHost-Apps/scovie_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/scovie_ynh.git synced 2024-09-03 20:16:29 +02:00
Code Issues Activity Actions 2

Merge pull request #6 from YunoHost-Apps/testing

Browse source 
fix documentation
This commit is contained in:
André Théo LAURET 2023-07-17 16:49:26 +04:00 committed by GitHub
commit 1b08588d17
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 138 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
README.md
View file

@ -22,58 +22,15 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
**Shipped version:** 0.0.6~ynh1 **Shipped version:** 0.0.6~ynh1
## Disclaimers / important information ## Disclaimers / important information
## local test
For quicker developing of scovie_ynh in the context of YunoHost app,
it's possible to run the Django development server with the settings
and urls made for YunoHost installation.
e.g.:
```bash
~$ git clone https://github.com/eldertek/scovie_ynh.git
~$ cd scovie_ynh/
~/scovie_ynh$ make
install-poetry install or update poetry
install install project via poetry
update update the sources and installation and generate "conf/requirements.txt"
lint Run code formatters and linter
fix-code-style Fix code formatting
tox-listenvs List all tox test environments
tox Run pytest via tox with all environments
pytest Run pytest
publish Release new version to PyPi
local-test Run local_test.py to run the project locally
local-diff-settings Run "manage.py diffsettings" with local test
~/scovie_ynh$ make install-poetry
~/scovie_ynh$ make install
~/scovie_ynh$ make local-test
```
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/`
## history
* [v0.0.5 - 27.05.2023](https://github.com/eldertek/scovie_ynh/compare/4b0275e7f75d199dca8a1e97c26dc8568c31cb52...4f0086c7da6123f3f8b05c4001f9109891e6bd9f)
* first working state
* [26.05.2023](https://github.com/eldertek/scovie_ynh/commit/4b0275e7f75d199dca8a1e97c26dc8568c31cb52)
* init the project
## Links ## Links
* Report a bug about this package: https://github.com/eldertek/scovie_ynh/issues * Report a bug about this package: https://github.com/eldertek/scovie/issues
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
* PyPi package: https://pypi.org/project/scovie/ * PyPi package: https://pypi.org/project/scovie/
These projects used `scovie_ynh`: These projects used `scovie`:
* https://github.com/eldertek/scovie_ynh * https://github.com/eldertek/scovie
--- ---

49
README_fr.md
View file

@ -22,58 +22,15 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
**Version incluse :** 0.0.6~ynh1 **Version incluse :** 0.0.6~ynh1
## Avertissements / informations importantes ## Avertissements / informations importantes
## local test
For quicker developing of scovie_ynh in the context of YunoHost app,
it's possible to run the Django development server with the settings
and urls made for YunoHost installation.
e.g.:
```bash
~$ git clone https://github.com/eldertek/scovie_ynh.git
~$ cd scovie_ynh/
~/scovie_ynh$ make
install-poetry install or update poetry
install install project via poetry
update update the sources and installation and generate "conf/requirements.txt"
lint Run code formatters and linter
fix-code-style Fix code formatting
tox-listenvs List all tox test environments
tox Run pytest via tox with all environments
pytest Run pytest
publish Release new version to PyPi
local-test Run local_test.py to run the project locally
local-diff-settings Run "manage.py diffsettings" with local test
~/scovie_ynh$ make install-poetry
~/scovie_ynh$ make install
~/scovie_ynh$ make local-test
```
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/`
## history
* [v0.0.5 - 27.05.2023](https://github.com/eldertek/scovie_ynh/compare/4b0275e7f75d199dca8a1e97c26dc8568c31cb52...4f0086c7da6123f3f8b05c4001f9109891e6bd9f)
* first working state
* [26.05.2023](https://github.com/eldertek/scovie_ynh/commit/4b0275e7f75d199dca8a1e97c26dc8568c31cb52)
* init the project
## Links ## Links
* Report a bug about this package: https://github.com/eldertek/scovie_ynh/issues * Report a bug about this package: https://github.com/eldertek/scovie/issues
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
* PyPi package: https://pypi.org/project/scovie/ * PyPi package: https://pypi.org/project/scovie/
These projects used `scovie_ynh`: These projects used `scovie`:
* https://github.com/eldertek/scovie_ynh * https://github.com/eldertek/scovie
--- ---

49
doc/DISCLAIMER.md
View file

@ -1,55 +1,12 @@
## local test
For quicker developing of scovie_ynh in the context of YunoHost app,
it's possible to run the Django development server with the settings
and urls made for YunoHost installation.
e.g.:
```bash
~$ git clone https://github.com/eldertek/scovie_ynh.git
~$ cd scovie_ynh/
~/scovie_ynh$ make
install-poetry install or update poetry
install install project via poetry
update update the sources and installation and generate "conf/requirements.txt"
lint Run code formatters and linter
fix-code-style Fix code formatting
tox-listenvs List all tox test environments
tox Run pytest via tox with all environments
pytest Run pytest
publish Release new version to PyPi
local-test Run local_test.py to run the project locally
local-diff-settings Run "manage.py diffsettings" with local test
~/scovie_ynh$ make install-poetry
~/scovie_ynh$ make install
~/scovie_ynh$ make local-test
```
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/`
## history
* [v0.0.5 - 27.05.2023](https://github.com/eldertek/scovie_ynh/compare/4b0275e7f75d199dca8a1e97c26dc8568c31cb52...4f0086c7da6123f3f8b05c4001f9109891e6bd9f)
* first working state
* [26.05.2023](https://github.com/eldertek/scovie_ynh/commit/4b0275e7f75d199dca8a1e97c26dc8568c31cb52)
* init the project
## Links ## Links
* Report a bug about this package: https://github.com/eldertek/scovie_ynh/issues * Report a bug about this package: https://github.com/eldertek/scovie/issues
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
* PyPi package: https://pypi.org/project/scovie/ * PyPi package: https://pypi.org/project/scovie/
These projects used `scovie_ynh`: These projects used `scovie`:
* https://github.com/eldertek/scovie_ynh * https://github.com/eldertek/scovie
--- ---