YunoHost/tartiflette
1
0
Fork 0
mirror of https://github.com/YunoHost/tartiflette.git synced 2024-09-03 20:06:08 +02:00
Code Issues Projects Releases Packages Wiki Activity

add further indications

Browse source
This commit is contained in:
= 2023-08-24 04:17:51 +02:00
parent b1c94f3997
commit 9d626327fe
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -20,7 +20,7 @@ source venv/bin/activate
pip install -r requirements.txt pip install -r requirements.txt
``` ```
- (optional) Configure `GITHUB_USER` and `GITHUB_TOKEN` in `/app/settings.py`. This is currently only required to: - (optional) For a full local deployment, configure `GITHUB_USER` and `GITHUB_TOKEN` in `/app/settings.py`. This is currently only required to:
- override Github's unregistered user API limitation during app catalog update which prevents from updating more than about 10 entries) via `appcatalog.py` - override Github's unregistered user API limitation during app catalog update which prevents from updating more than about 10 entries) via `appcatalog.py`
- perform some maintenance watch tasks via `maintenancePing.py` - perform some maintenance watch tasks via `maintenancePing.py`
@ -37,4 +37,16 @@ pip install -r requirements.txt
./manage.py update ./manage.py update
``` ```
Note: script files located at `app/scripts/` are meant to be executed via `cron`. Therefore for local development purpose they can be triggered manually. - Scripts files located at `app/scripts/` are meant to be executed via `cron`. Therefore for local development purpose they can be triggered manually. For instance, to be able to display catalog news and history, run:
```
python app/scripts/appListsHistory/script.py
```
- That will output a few json files at the repo root (count-history.json, news.json and news_rss.json ) that you will have to move manually to the directory `app/scripts/appListsHistory/`.
- To browse the webapp locally, run from the repo root:
```
flask run
```
- And open the URL that gets displayed in the terminal (e.g. http://127.0.0.1:5000/ ).