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 details to the README

Browse source
This commit is contained in:
= 2023-08-22 18:50:40 +02:00
parent 61806b3323
commit cf2a96f611
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -14,13 +14,15 @@ virtualenv -p python3 venv
source venv/bin/activate source venv/bin/activate
``` ```
- Install the dependencies : - Install the dependencies:
``` ```
pip install -r requirements.txt pip install -r requirements.txt
``` ```
- Configure `GITHUB_USER` and `GITHUB_TOKEN` in settings.py - (optional) 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`
- perform some maintenance watch tasks via `maintenancePing.py`
- Init the database : - Init the database :
@ -34,3 +36,5 @@ 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.