Browse Source

make/README.md z make_docs

pull/11/head
Pavel "LEdoian" Turinsky 2 years ago
parent
commit
9c92ca6575
  1. 43
      make/README.md

43
make/README.md

@ -1,34 +1,9 @@
Milý člověče, M&Mí web tě vítá. Prosím, neděs se, zkusím tě provést lokálním zprovozněním webu.
Předně: většina příkazů bude asi vypisovat spoustu detailů, takže ti doporučuji
si tento text otevřít někde separátně. Nachází se v repozitáři v
`make/README.md`, případně si jej můžeš zobrazit hezčeji vykreslený na
[Gitee](https://gitea.ks.matfyz.cz/mam/mamweb/src/branch/master/make/README.md).
O zprovoznění webu se stará hlavně skript `make/install_web`. Ten vytvoří
virtualenv (neexistuje-li) a nainstaluje do něj závislosti webu. Pak ovšem
budeš potřebovat nahrát další data do databáze, což uděláš pomocí příkazů
`./manage.py testdata` a `./manage.py loaddata data/*`. Skript
`make/install_web` ti to kdyžtak připomene.
Samotný web spustíš třeba pomocí `make/run`, nebo ekvivalentně `./manage.py runserver`.
Pozor: zatímco skripty v `make/` to nepotřebují, pro použití skriptu
`./manage.py` se potřebuješ přepnout do virtuálního prostředí. To uděláš velmi
pravděpodobně spuštěním `source env/bin/activate`, před začátkem _promptu_ by
se mělo objevit `(env)`. Pro opuštění spusť `deactivate`.
Časté problémy
-----
Je možné, že nemáš všechny potřebné závislosti v systému. Proto je možné, že
`make/install_web` vyhodí nějakou chybovou hlášku:
- `Error: pg_config executable not found.`: nainstaluj si `libpq-dev` (na Ubuntu/Debianu, jinde se příslušný balíček může jmenovat jinak)
- Chybová hláška obsahuje `#include <Python.h>`: nainstaluj si `python3-dev`
<!--
FIXME: Protože tento soubor vypisujeme, tak nemůžeme zobrazit aktuální cestu
venvu, takže tu kvůli tomu jsou hardcodované cesty. Asi by se mohl nějak
generovat ze šablony, která má přístup k make/lib.sh, ale zatím to není implementované.
-->
TL;DR: Web vyrobíš pomocí následující posloupnosti příkazů:
make/install_web
. env/bin/activate
./manage.py testdata
./manage.py loaddata data/*
make/run
a web potom najdeš na <http://127.0.0.1:8000>
Pro detaily a nápovědu si prosím přečti dokumentaci v docs/vyvoj.rst.

Loading…
Cancel
Save