537 changed files with 55968 additions and 99599 deletions
@ -1,154 +1,9 @@ |
|||||
PYTHON ?= python3 |
# Existence tohohle Makefile je tu jen proto, aby fungovala svalová paměť. Pokud můžete, použijte rovnou `make/…`
|
||||
VENV ?= ${PYTHON} -m venv |
%: |
||||
# Všechny flagy, které se s venvem/virtualenvem/... mají volat patří sem. Volá se "${VENV} cesta"
|
# Používání make jako příkazu je zastaralé, prosím používej radši skripty ze složky make. Spouštím následující příkaz: |
||||
VENV_PATH ?= env |
make/$* |
||||
# Musí být definovaná, i kdyby to měla být "."
|
|
||||
|
|
||||
.PHONY: all venv_check clean install install_web install_venv clean_venv clean_schema run test deploy_test deploy_prod sync_test_media sync_test_db sync_test sync_local_media sync_local_db sync_local |
default: |
||||
|
@cat make/README.md |
||||
|
|
||||
# activate by mělo být předpokladem ke všemu, co volá webový python (i.e. python nasazený do ${VENV}u kvůli webu, např. manage.py)
|
.PHONY: default |
||||
all: |
|
||||
@# Just echo: |
|
||||
# Install je trochu magický: |
|
||||
# Spusť následující posloupnost příkazů: |
|
||||
# make install_venv |
|
||||
# . ${VENV_PATH}/bin/activate |
|
||||
# make install_web |
|
||||
# |
|
||||
# Pokud install_web říká Error: pg_config executable not found. nainstaluj si libpq-dev |
|
||||
# Pokud chybová hláška obsahuje #include <Python.h>, nainstaluj si python3-dev |
|
||||
# |
|
||||
# Až skončíš s vývojem webu, spusť "deactivate". Tím zmizí '(${VENV_PATH})' ze začátku promptu. |
|
||||
|
|
||||
venv_check: |
|
||||
@# Pokud org nemá zapnutý venv, poradíme mu, aby si ho zapnul a spadneme. Jinak nic. |
|
||||
@expr $$PATH : ".*:*$(shell pwd)/${VENV_PATH}/bin" > /dev/null && exit 0 || echo 'Není zapnutý venv, spusť ". ${VENV_PATH}/bin/activate".\nPokud není venv nainstalovaný, spusť "make install_venv"' && false |
|
||||
|
|
||||
clean: clean_venv clean_schema |
|
||||
|
|
||||
install: install_web |
|
||||
|
|
||||
install_web: venv_check |
|
||||
@# venv může být příšerně starý, takže nejdříve upgradujeme venvové věci |
|
||||
pip install --upgrade pip |
|
||||
pip install --upgrade setuptools |
|
||||
# Instalace závislostí webu |
|
||||
pip install -r requirements.txt --upgrade |
|
||||
# Pro vygenerování tesdat spusť ./manage.py testdata |
|
||||
# Po vygenerování testdat spusť ./manage.py loaddata data/*, ať máš menu a další modely |
|
||||
# Pro synchronizaci flatpages spusť make sync_prod_flatpages |
|
||||
|
|
||||
install_venv: |
|
||||
${VENV} ${VENV_PATH} |
|
||||
|
|
||||
clean_venv: |
|
||||
# Možná není 100% foolproof... |
|
||||
@test ! ${VENV_PATH} = . || ! echo "Smaž si prosím venv sám, nebudu mazat celý web" |
|
||||
rm -rfv ${VENV_PATH} |
|
||||
rm -f pip-selfcheck.json |
|
||||
clean_schema: |
|
||||
rm -f schema_seminar.pdf schema_all.pdf |
|
||||
|
|
||||
run: venv_check |
|
||||
./manage.py runserver |
|
||||
|
|
||||
test: venv_check |
|
||||
./manage.py test -v2 seminar mamweb |
|
||||
|
|
||||
# DB schemata
|
|
||||
|
|
||||
schema: schema_seminar.pdf schema_all.pdf |
|
||||
|
|
||||
schema_seminar.pdf: venv_check |
|
||||
./manage.py graph_models seminar | dot -Tpdf > schema_seminar.pdf |
|
||||
|
|
||||
schema_all.pdf: venv_check |
|
||||
./manage.py graph_models -a -g | dot -Tpdf > schema_all.pdf |
|
||||
|
|
||||
# Deploy to current *mamweb-test* directory
|
|
||||
deploy_test: venv_check |
|
||||
@if [ ${USER} != "mam-web" ]; then echo "Only possible by user mam-web"; exit 1; fi |
|
||||
@if [ `readlink -f .` != "/aux/akce/mam/www/mamweb-test" ]; then echo "Only possible in directory mamweb-test"; exit 1; fi |
|
||||
@echo "Installing version from origin/test ..." |
|
||||
git pull origin test |
|
||||
git clean -f |
|
||||
make install |
|
||||
./manage.py migrate |
|
||||
./manage.py collectstatic --noinput |
|
||||
(chown -R :mam . || true ) |
|
||||
(chmod -R g+rX,go-w . || true ) |
|
||||
@echo Restarting systemd unit |
|
||||
systemctl --user restart mamweb-test.service |
|
||||
@echo Done. |
|
||||
|
|
||||
# Deploy to current *mamweb-prod* directory
|
|
||||
deploy_prod: venv_check |
|
||||
@if [ ${USER} != "mam-web" ]; then echo "Only possible by user mam-web"; exit 1; fi |
|
||||
@if [ `readlink -f .` != "/aux/akce/mam/www/mamweb-prod" ]; then echo "Only possible in directory mamweb-prod"; exit 1; fi |
|
||||
@echo "Backing up production DB ..." |
|
||||
( cd -P .. && ./backup_prod_db.sh ) |
|
||||
@echo "Installing version from origin/master ..." |
|
||||
git pull origin master |
|
||||
git clean -f |
|
||||
make install |
|
||||
./manage.py migrate |
|
||||
./manage.py collectstatic --noinput |
|
||||
(chown -R :mam . || true ) |
|
||||
(chmod -R g+rX,go-w . || true ) |
|
||||
@echo Restarting systemd user unit for MaM web |
|
||||
systemctl --user restart mamweb-prod.service |
|
||||
@echo Done. |
|
||||
|
|
||||
|
|
||||
sync_prod_flatpages: venv_check |
|
||||
@echo Downloading current version of flatpages from mamweb-prod. |
|
||||
ssh mam-web@gimli.ms.mff.cuni.cz \
|
|
||||
"cd /akce/mam/www/mamweb-prod; . env/bin/activate; ./manage.py dumpdata flatpages --indent=2 > flat.json; ./fix_json.py flat.json flat_fixed.json" |
|
||||
rsync -ave ssh mam-web@gimli.ms.mff.cuni.cz:/akce/mam/www/mamweb-prod/flat_fixed.json data/flat.json |
|
||||
@echo "Applying downloaded flatpages." |
|
||||
./manage.py loaddata data/flat.json |
|
||||
@echo "Done." |
|
||||
|
|
||||
# Sync test media directory with production
|
|
||||
sync_test_media: |
|
||||
@if [ ${USER} != "mam-web" ]; then echo "Only possible by user mam-web"; exit 1; fi |
|
||||
@if [ `readlink -f .` != "/aux/akce/mam/www/mamweb-test" ]; then echo "Only possible in /akce/mam/www/mamweb-test"; exit 1; fi |
|
||||
rsync -av --delete /akce/mam/www/mamweb-prod/media/ ./media |
|
||||
|
|
||||
# Sync (with drop) test database with production database
|
|
||||
sync_test_db_aggressive: |
|
||||
@if [ ${USER} != "mam-web" ]; then echo "Only possible by user mam-web"; exit 1; fi |
|
||||
pg_dump mam_test > dump-test-`date +"%Y%m%d_%H%M"`.sql |
|
||||
pg_dump -Fc mam_prod > dump-prod.sql |
|
||||
@# I am not sure which shell is used, so I am calling bash to make sure |
|
||||
psql mam_test -c 'DROP OWNED BY "mam-web";' |
|
||||
pg_restore -c --if-exists -d mam_test dump-prod.sql |
|
||||
rm dump-prod.sql |
|
||||
psql mam_test -c "UPDATE django_site SET name='MaMweb (test)', domain='mam-test.ks.matfyz.cz' WHERE id=1" |
|
||||
@echo Done. |
|
||||
|
|
||||
# Sync test with production
|
|
||||
# HACK ALERT: using aggressive variant, due to the schemas being too different.
|
|
||||
sync_test: sync_test_media sync_test_db_aggressive |
|
||||
|
|
||||
|
|
||||
# Sync media directory with atrey. Useful for local development with production database
|
|
||||
# Does not sync Galerie and CACHE (too huge).
|
|
||||
sync_local_media: |
|
||||
rsync -ave ssh --exclude Galerie --exclude CACHE\
|
|
||||
mam-web@gimli.ms.mff.cuni.cz:/akce/mam/www/mamweb-prod/media/ ./media/ |
|
||||
# Downloads and restores production database to local database. PostgreSQL only.
|
|
||||
sync_local_db: |
|
||||
scp mam-web@gimli.ms.mff.cuni.cz:`ssh mam-web@gimli.ms.mff.cuni.cz 'ls -v /akce/mam/www/backups/mam_prod-*\.pgdump.xz | tail -n 1'` \
|
|
||||
./last.pgdump.xz |
|
||||
xz -fd last.pgdump.xz |
|
||||
pg_restore -c -d mam-prod last.pgdump |
|
||||
|
|
||||
# Sync database and media. See above lines
|
|
||||
sync_local: sync_local_media sync_local_db |
|
||||
|
|
||||
# Push local compiled Vue to gimli test site
|
|
||||
push_compiled_vue_to_test: |
|
||||
scp vue_frontend/webpack-stats.json mam-web@gimli:/akce/mam/www/mamweb-test/vue_frontend/ |
|
||||
rsync -ave ssh seminar/static/seminar/vue mam-web@gimli:/akce/mam/www/mamweb-test/seminar/static/seminar/ |
|
||||
ssh mam-web@gimli.ms.mff.cuni.cz 'cd /akce/mam/www/mamweb-test/ && . env/bin/activate && ./manage.py collectstatic --noinput' |
|
||||
|
|||||
@ -1,77 +1,58 @@ |
|||||
Basic commands for web development |
Web M&M |
||||
================================== |
====== |
||||
|
|
||||
After you clone this repository, run `make`. It will download, locally install |
Tohle je repozitář s kódem M&Mího webu. Pokud zde hledáte web samotný nebo |
||||
and setup virtualenv and pip, and then locally install all required packages |
informace o semináři, najdete je na <https://mam.matfyz.cz> (a upřímně nechápu, |
||||
from `requirements.txt`. |
jak jste se dostali k tomuhle textu :-D) |
||||
|
|
||||
When working with the code, always use the binaries in `./bin/`, such as |
Pokud jste tu zůstali, tak vás beztak zajímá vývoj webu (a jestli ne, tak |
||||
`bin/pip`, `bin/python`, ... never the global python, pip, ... |
budeme rádi, když začne :-)). |
||||
Use `make` and `./manage.py` for most things. |
|
||||
|
Co je M&Mweb uvnitř |
||||
Use git :-) |
------ |
||||
|
Celý náš web je napsaný v [Pythonu](https://www.python.org) ve frameworku |
||||
Quickstart |
[Django](https://www.djangoproject.com/). Web běží na serveru zvaném Gimli, |
||||
---------- |
jako databázi používá PostgreSQL (pro lokální vývoj naopak SQLite) a všechen |
||||
Run the following commands: |
náš kód je uložený v [Gitu](https://git-scm.com/) na [téhle |
||||
make install_venv |
gitee](https://gitea.ks.matfyz.cz/). Pro dokumentaci používáme |
||||
. env/bin/activate |
[Sphinx](https://www.sphinx-doc.org). |
||||
make install_web |
|
||||
|
<!--TODO: Z odstavce výše by ideálně měla být zachována jen první věta a zbytek |
||||
Pokud install_web říká Error: pg_config executable not found. nainstaluj si libpq-dev |
by měl být někde v docs s podrobnějším popisem…--> |
||||
Pokud chybová hláška obsahuje #include <Python.h>, nainstaluj si python3-dev |
|
||||
|
Jak si web pořídit |
||||
After finishing development, run "deactivate". |
------ |
||||
|
Prosím přečti si podrobnější návod v <docs/vyvoj.rst> (tady by bylo zbytečné |
||||
Make commands |
ho duplikovat). |
||||
------------- |
|
||||
|
Jak web vyvíjet |
||||
* `make install` (or `make`) - locally install and setup virtualpy, install |
---- |
||||
required packages. Ran again installs missing packages. Run after changing |
<!--TODO: Napsat obšírněji, asi zase do docs/--> |
||||
`requirements.txt`. |
|
||||
|
Na webu je mnoho věcí k dělání, některé ani nevyžadují kódění (třeba uhánění |
||||
* `make clean` - remove local python packages. |
orgů, aby si psali medailonky, aktualizace fotek, …), některé se naopak týkají |
||||
|
infrastruktury pod kódem (Gitea, Gimli, …). Je proto těžké mít na to úplně |
||||
* `make veryclean` - remove local packages and virtualpy enviroment and |
obecný návod, tak tady je zhruba návod na úpravy kódu a pokud se něco z toho |
||||
binaries. |
nedá aplikovat, tak to prostě zkus nějak udělat jinak, po svém. (Omlouvám se |
||||
|
neinformatikům, ale líp to teď nesepíšu :-)) |
||||
* `make run` - runs "./manage.py runserver_plus" |
|
||||
|
1. Nejprve si stáhni repozitář a rozběhni si lokální web u sebe (viz <docs/vyvoj.rst>). |
||||
* `make push_test` - pushes the last commited version to test location. |
1. Najdi si problém v Kanboardu (klikni na „Issues“ na Gitee) a/nebo se domluv |
||||
Only git-commited changes are pushed! Rest is re-generated from scratch. |
s webaři, na čem bys tak mohl/a pracovat. |
||||
At test server, the media data and database are kept the same. |
1. Najdi místo, kde se to dá opravit a zkus to tam opravit. Uznávám, že tenhle |
||||
Everything else not in .gitignore is deleted/overwritten on the test server. |
bod je otravně obecný, pokud tápeš, zkus se zeptat zkušenějších webařů nebo |
||||
|
podívat do dokumentace. |
||||
* `make schema` - generates graph of seminar and all schemas as PDF. Supercool! |
1. Vyzkoušej, že ti to lokálně funguje tak, jak má. |
||||
|
1. Zvládneš-li a máš-li čas, zkus to i zdokumentovat a/nebo napsat testy (TODO: chybí návod) |
||||
* `make sync_prod_flatpages` - downloads and applies static/flat pages from mamweb-prod |
1. Po dohodě s webaři to vyzkoušej na testwebu |
||||
|
1. Pošli pull-request a případně zkus reagovat na komentáře |
||||
./manage.py commands |
1. Až se změna začlení do hlavní větve (`master`) a nasadí se web na produkci, |
||||
-------------------- |
můžeš mít radost, že se web bude používat lépe Tobě i ostatním orgům :-) |
||||
|
|
||||
* `./manage.py migrate` - update the database schema, initialise the database. |
### Proč pull-requesty? |
||||
You need to run this in the beginning. |
<!--FIXME: Tohle ale už úplně patří do docs a ne sem, jen je zatím nemám prozkoumané…--> |
||||
|
|
||||
* `./manage.py runserver_plus` - run a debugging server for the web. Slightly |
Účelů pull-requestů je několik. Jednak doufáme, že pomůže webařům se orientovat |
||||
enhanced compared to `./manage.py runserver`. |
v kódu, jednak tím umožňujeme dělat experimenty a dávat si zpětnou vazbu. V |
||||
Open [127.0.0.1:8000](127.0.0.1:8000). |
neposlední řadě pomáhají držet aspoň trochu konzistentní kód, což má pomoci |
||||
|
pohodě při programování… (A asi jsem na něco zapomněl :-)) |
||||
* `./manage.py testdata` - create pseudo-random seminar data and admin/admin |
|
||||
user. |
|
||||
|
|
||||
* `./manage.py test` - run the tests. |
|
||||
|
|
||||
* `./manage.py shell` - run commands, list elemements of database, check syntax |
|
||||
by importing files, etc. |
|
||||
|
|
||||
Configurations |
|
||||
-------------- |
|
||||
|
|
||||
* `mamweb/settings_common.py` contains most configuration options. |
|
||||
* `mamweb/settings.py` is used only for local development. |
|
||||
* `mamweb/settings_test.py` is used for testing on atrey. |
|
||||
* `mamweb/settings_prod.py` is used in production deployment. |
|
||||
|
|
||||
These are automatically switched by `make`. |
|
||||
|
|
||||
|
|
||||
|
|||||
@ -1,16 +0,0 @@ |
|||||
git hooks |
|
||||
========= |
|
||||
|
|
||||
Kontrola stylu pythoních zdrojáků pomocí flake8. Kontrolujeme jen změny, |
|
||||
abychom nenutili lidi dělat nesouvisející úpravy, které by rozbíjely historii |
|
||||
(git blame). |
|
||||
|
|
||||
pre-commit |
|
||||
---------- |
|
||||
* kontrola změn před commitnutím |
|
||||
* instalace: lokálně zkopírovat do .git/hooks (musí být spustitelný) |
|
||||
|
|
||||
update |
|
||||
------ |
|
||||
* kontrola změn přicházejících s pushem |
|
||||
* instalace: na atreyi zkopírovat do /akce/MaM/MaMweb/mamweb.git/hooks |
|
||||
@ -1,30 +0,0 @@ |
|||||
#!/bin/sh |
|
||||
# |
|
||||
# Git hook script to verify what is about to be committed. |
|
||||
# Checks that the changes don't introduce new flake8 errors. |
|
||||
|
|
||||
TMPDIFF=`tempfile` |
|
||||
FLAKE8="`git rev-parse --show-toplevel`/bin/flake8" |
|
||||
|
|
||||
status=0 |
|
||||
|
|
||||
# select only changed python files which are not migrations |
|
||||
changed=`git diff --cached --name-only | grep 'py$' | grep -v 'migrations/[0-9]'` |
|
||||
if [ -z $changed ] ; then |
|
||||
# Nothing to check. Note the exit is necessary -- we would not pass any |
|
||||
# paths to git diff below and it would output the diff unfiltered. |
|
||||
exit 0 |
|
||||
fi |
|
||||
|
|
||||
git diff --unified=1 --cached HEAD -- $changed > $TMPDIFF |
|
||||
|
|
||||
# only do the check when there are some changes to be commited |
|
||||
# otherwise flake8 would hang waiting for input |
|
||||
if [ -s $TMPDIFF ] ; then |
|
||||
cat $TMPDIFF | $FLAKE8 --diff |
|
||||
status=$? |
|
||||
fi |
|
||||
|
|
||||
rm -f $TMPDIFF |
|
||||
|
|
||||
exit $status |
|
||||
@ -1,61 +0,0 @@ |
|||||
#!/bin/sh |
|
||||
|
|
||||
# git update hook to check that pushed changes don't introduce new flake8 |
|
||||
# errors |
|
||||
|
|
||||
# --- Command line |
|
||||
refname="$1" |
|
||||
oldrev="$2" |
|
||||
newrev="$3" |
|
||||
|
|
||||
# --- Safety check |
|
||||
if [ -z "$GIT_DIR" ]; then |
|
||||
echo "Don't run this script from the command line." >&2 |
|
||||
echo " (if you want, you could supply GIT_DIR then run" >&2 |
|
||||
echo " $0 <ref> <oldrev> <newrev>)" >&2 |
|
||||
exit 1 |
|
||||
fi |
|
||||
|
|
||||
if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then |
|
||||
echo "usage: $0 <ref> <oldrev> <newrev>" >&2 |
|
||||
exit 1 |
|
||||
fi |
|
||||
|
|
||||
|
|
||||
TMPDIR=`mktemp -d` |
|
||||
TMPDIFF=`tempfile` |
|
||||
|
|
||||
[ $refname != "refs/heads/master" -a $refname != "refs/heads/stable" ] && exit 0 |
|
||||
|
|
||||
# select only changed python files which are not migrations |
|
||||
changed=`git diff --name-only $oldrev $newrev | grep 'py$' | grep -v 'migrations/[0-9]'` |
|
||||
if [ -z $changed ] ; then |
|
||||
# Nothing to check. Note the exit is necessary -- we would not pass any |
|
||||
# paths to git diff below and it would output the diff unfiltered. |
|
||||
exit 0 |
|
||||
fi |
|
||||
|
|
||||
git diff --unified=1 $oldrev $newrev -- $changed >${TMPDIFF} |
|
||||
|
|
||||
# there is no working tree in bare git repository, so we recreate it for flake8 |
|
||||
git archive $newrev | tar -x -C ${TMPDIR} |
|
||||
|
|
||||
cd ${TMPDIR} |
|
||||
# report only errors on lines in diff |
|
||||
# (if threre was flake8 installed on atrey, we could just call flake8) |
|
||||
/akce/MaM/WWW/mamweb-test/bin/flake8 --diff <${TMPDIFF} |
|
||||
status=$? |
|
||||
if [ $status != 0 ] ; then |
|
||||
echo |
|
||||
echo -n "Změny, které se snažíte pushnout, obsahují kód v pythonu " |
|
||||
echo -n "nevyhovující flake8 (viz výše). Opravte je a zkuste to znovu. " |
|
||||
echo -n "Nezapomeňte, že můžete editovat historii (git commit --amend, " |
|
||||
echo -n "git rebase -i). Pokud byste chybu příště raději odhalili už při " |
|
||||
echo "commitu, zkopírujte si pre-commit hook z _git_hooks do .git/hooks." |
|
||||
echo |
|
||||
fi |
|
||||
|
|
||||
rm -rf ${TMPDIR} |
|
||||
rm -f ${TMPDIFF} |
|
||||
|
|
||||
exit $status |
|
||||
@ -1,8 +1,5 @@ |
|||||
""" |
|
||||
Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace. |
|
||||
""" |
|
||||
from django.apps import AppConfig |
from django.apps import AppConfig |
||||
|
|
||||
|
|
||||
class AesopConfig(AppConfig): |
class AesopConfig(AppConfig): |
||||
name = 'aesop' |
name = 'aesop' |
||||
|
verbose_name = 'Export do AESOPa' |
||||
|
|||||
@ -1,8 +1,6 @@ |
|||||
""" |
|
||||
Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace. |
|
||||
""" |
|
||||
from django.apps import AppConfig |
from django.apps import AppConfig |
||||
|
|
||||
|
|
||||
class ApiConfig(AppConfig): |
class ApiConfig(AppConfig): |
||||
name = 'api' |
name = 'api' |
||||
|
verbose_name = 'Různá webová API' |
||||
|
|||||
@ -1,7 +1,2 @@ |
|||||
""" |
|
||||
Soubory sloužící k deklaraci jednotlivých „views“ (nejčastěji funkce beroucí request |
|
||||
a vracející :func:`django.shortcuts.render` respektive nějakou response, nebo |
|
||||
třídy většinou rozšiřující nějakou třídu z :mod:`django.views.generic`) |
|
||||
""" |
|
||||
from .autocomplete import * |
from .autocomplete import * |
||||
from .exports import * |
from .exports import * |
||||
|
|||||
File diff suppressed because one or more lines are too long
@ -0,0 +1,27 @@ |
|||||
|
CSS (a další styly na webu) |
||||
|
=========================== |
||||
|
|
||||
|
Inspirován `css-trick článkem <https://css-tricks.com/methods-organize-css/>`_ jsem se rozhodl rozdělit |
||||
|
CSSka do |
||||
|
|
||||
|
- Konstant (``constants.css``), které jsou využívány na mnoha místech CSSek |
||||
|
- Nastylování html tagů (``base.css``) |
||||
|
- Layoutu (``layout.css``), což je to, co určuje celkové rozložení stránky |
||||
|
- Jednotlivých prvků (``modules.css``) |
||||
|
|
||||
|
Dále jsem separoval CSSka pro **galerii** (potřebuje hodně specifických stylů). Stejně tak **korekturovátko** má styly separátně. |
||||
|
|
||||
|
Dále web (asi) používá externí frameworky (v separátních složkách – mají k sobě i JS a podobné věci): |
||||
|
|
||||
|
- bootstrap: dělá nějaké basic stylování, *web je na něm hodně závislý* (například jsem zjistil, že bootstrap kdysi přidával ``font-size:14px``, bez čehož se web úplně rozpadnul) (také na něm běží mobilní meníčko, které navíc vyžaduje Popper, tedy bootstrap.bundle.js místo bootstrap.js) |
||||
|
|
||||
|
Pak jsou tu ``mamweb-dev.css`` a ``printtable.css``, co jsem si ještě nerozmyslel, co s tím. |
||||
|
|
||||
|
Pár myšlenek |
||||
|
------------ |
||||
|
|
||||
|
- Až na pár výjimek (galerii a korekturovátko) bych styly držel v jedné složce a málo souborech, |
||||
|
protože CSS šíleně dědí všechno možné |
||||
|
- Chce to dobře pojmenovávat třídy (speciálně aby bylo vidět, co ta třída dělá nebo kde se používá) |
||||
|
- Chce to hodně komentovat kód (speciálně tam, kde není splněn předchozí bod) |
||||
|
|
||||
@ -1,3 +1,4 @@ |
|||||
|
FIXME přepsat do rst, přidat i další věci a případně přesunout na wiki |
||||
Přidání obrázků do odměn: |
Přidání obrázků do odměn: |
||||
admin -> flatpage odměn -> ikona přidat obrázek |
admin -> flatpage odměn -> ikona přidat obrázek |
||||
záložka odeslat, vybrat obrázek, odeslat |
záložka odeslat, vybrat obrázek, odeslat |
||||
@ -0,0 +1,108 @@ |
|||||
|
Skripty pro práci s repozitářem |
||||
|
=================== |
||||
|
|
||||
|
Máme dvě hlavní sady skriptů/příkazů na ovládání webu a repozitáře. Skripty pro |
||||
|
práci s webem psané v Pythonu jsou uložené ve složkách |
||||
|
``<aplikace>/management/commands/``, případně vestavěné, a volají se pomocí |
||||
|
``./manage.py <příkaz>``. Oproti tomu skripty pro práci s repozitářem a pro |
||||
|
úpravy databáze a souborů „zvenčí“ se nejčastěji nacházejí ve složce ``make/`` |
||||
|
a volají se pomocí cesty: ``make/<příkaz>``. |
||||
|
|
||||
|
Občas existují i nějaké další skripty na různých jiných místech. Všechny by |
||||
|
měly být ideálně popsány asi tady. |
||||
|
|
||||
|
Make skripty |
||||
|
---- |
||||
|
|
||||
|
Skripty v ``make/`` se označují jako „Make skripty“. Slouží často k velkým |
||||
|
úkonům s repozitářem, jako je nasazení celého webu, zprovoznění lokálního webu |
||||
|
a podobně. |
||||
|
|
||||
|
.. note:: Označení pro tyto skripty je dáno tím, že byly původně volány pomocí |
||||
|
make (tj. z Makefile). Ve skutečnosti je lze stále volat i jako ``make |
||||
|
<skript>``, ale pak není možné předávat parametry a obecně je tato cesta |
||||
|
zastaralá a existuje jen pro zpětnou kompatibilitu se svalovou pamětí. |
||||
|
|
||||
|
Tyto skripty jsou samonosné, dají se spustit rovnou a v případě problémů si |
||||
|
budou hlasitě stěžovat. Pro účely debugování různých věcí jsou ale (bohužel?) |
||||
|
hlasité i při normálním spuštění, konkrétně vypisují všechny příkazy, které se |
||||
|
spouštějí (\ ``set -x``). Tyto příkazy jsou vidět za jedním či více plusky (\ ``+``). |
||||
|
|
||||
|
.. tip:: Pokud některý make skript selže, tak by na konci měl vypsat, že se něco nepovedlo. |
||||
|
|
||||
|
|
||||
|
Knihovna ``make/lib.sh`` |
||||
|
^^^^^^ |
||||
|
|
||||
|
Pro pohodlí při psaní velká část z nich využívá knihovnu uloženou |
||||
|
v ``make/lib.sh``. Jsou zde definované užitečné proměnné, kontroly a společný |
||||
|
kód. Kromě toho při inicializaci otestuje, že je skript spuštěn z kořene |
||||
|
repozitáře (takže to pak není potřeba zkoumat v ostatních skriptech). |
||||
|
|
||||
|
Proměnné |
||||
|
""""" |
||||
|
|
||||
|
Popsány jsou jen užitečné proměnné, ve skutečnosti jich je definovaných víc, |
||||
|
ale jsou triviální a samopopisné. |
||||
|
|
||||
|
``VENV_PATH`` |
||||
|
Cesta virtuálního prostředí. Též lze přepsat. |
||||
|
``REPO`` |
||||
|
Cesta ke gitovému repozitáři na serveru, rovnou použitelná v ``git clone`` |
||||
|
``GIMLI_LOGIN`` |
||||
|
Přihlašovací údaje ke Gimlimu |
||||
|
``PRODWEB`` a ``TESTWEB`` |
||||
|
Cesty ke složkám s produkčním a testovacím webem |
||||
|
|
||||
|
Funkce a další zkratky |
||||
|
"""""" |
||||
|
|
||||
|
``ensure_venv`` |
||||
|
Zajistí, že se zbytek skriptu spustí ve virtuálním prostředí, a pokud neexistuje, tak jej založí. |
||||
|
``ensure_web_installed`` |
||||
|
Vyzkouší, že je web (django) aspoň elementárně zprovozněno a pokud ne, tak vyzve uživatele, aby to spravil. |
||||
|
``gimli_only`` |
||||
|
Otestuje, že je příkaz spuštěn na Gimlim, pokud tomu tak není, zeptá se, jestli si uživatel skutečně přeje zbytek skriptu vykonat |
||||
|
``only_in_directory <složka>`` |
||||
|
Otestuje, že skript běží z konkrétní složky. Zejména použitelné s ``gimli_only`` a ``$TESTWEB`` |
||||
|
``safe_checkout_branch <větev>`` |
||||
|
Bezpečně přepne repozitář na jinou větev. Pokud by mělo dojít k přepsání |
||||
|
knihovny nebo volajícího make skriptu, vyzve uživatele, aby přepnul ručně. |
||||
|
``install_everything`` |
||||
|
Společná část kódu pro nasazování produkce a testwebu. |
||||
|
|
||||
|
Skripty pro lokální vývoj |
||||
|
^^^^^^^ |
||||
|
|
||||
|
``make/install_web`` (nebo ekvivalentně ``make/install``) |
||||
|
Vytvoří virtualenv a nainstaluje do něj závislosti webu podle ``requirements.txt``. Následně popíše, jak vyrobit zbytek lokálního webu. |
||||
|
``make/run`` |
||||
|
Spustí lokální web (ekvivalentní s ``./manage.py runserver``) |
||||
|
``make/schema`` |
||||
|
Vykreslí závislosti a atributy modelů |
||||
|
``make/sync_prod_flatpages`` |
||||
|
Stáhne z produkce aktuální statické stránky a uloží je do složky ``data/`` |
||||
|
``make/test`` |
||||
|
Spustí testy (ekvivalentní s ``./manage.py test -v2``) |
||||
|
``make/init_local`` |
||||
|
Zkratka za posloupnost ``make/install_web``, ``./manage.py testdata``, ``./manage.py loaddata data/*``, ``make/sync_prod_flatpages`` |
||||
|
|
||||
|
Práce s testwebem |
||||
|
^^^^^^^ |
||||
|
|
||||
|
``make/deploy`` |
||||
|
Nasadí testweb. Volitelně bere jako parametr jméno větve, kterou má nasadit. |
||||
|
Rovnou nastaví přihlašování a vygeneruje příslušnou verzi dokumentace `sem <https://mam-test.ks.matfyz.cz/docs>`_. |
||||
|
``make/push_compiled_vue_to_test`` |
||||
|
**Neotestováno** Nahraje Vue z lokálního počítače na testweb. (Gimli často má moc starou verzi Node.js, takže nejde zkompilovat tam) |
||||
|
``make/sync_test_db_aggressive`` |
||||
|
Zkopíruje databázi z produkčního webu. |
||||
|
``make/sync_test_media`` |
||||
|
Zkopíruje média (obrázky, nahrané soubory) z produkčního webu. |
||||
|
``make/sync_test`` |
||||
|
Zkratka za ``make/sync_test_db_aggressive`` + ``make/sync_test_media``. |
||||
|
|
||||
|
Nasazení produkce |
||||
|
^^^^ |
||||
|
|
||||
|
``make/deploy_prod``. Před samotným nasazením zálohuje databázi a zkontroluje, že se nasazuje větev ``master``. |
||||
@ -0,0 +1,31 @@ |
|||||
|
Co kde najít (mamweb + django) |
||||
|
============================== |
||||
|
|
||||
|
Nejdůležitější aplikace z pohledu djanga je ``mamweb``. Tu totiž django pouští |
||||
|
a obsahuje tedy nastavení (tam se přidávají ostatní aplikace, včetně těch |
||||
|
importovaných z djanga, a nastavují se tam různé věci jak v djangu, tak i naše, |
||||
|
například složky, kam se budou věci přidané uživateli ukládat). Dále obsahuje |
||||
|
základní urls, udávající, „na jaké adrese co je“. A nakonec obsahuje obecné |
||||
|
věci jako chybové hlášky a vzhled M&M stránek (menu, patička, atd.). Aktuálně |
||||
|
i veškeré csv. |
||||
|
|
||||
|
Další jsou pak jednotlivé aplikace (pokud něco hledáte, tak zřejmě chcete najít |
||||
|
tu aplikaci, která tomu odpovídá, respektive se k ní dostat přes url), za |
||||
|
zmínku stojí seminar, kde jsou takové ty věci, co zbyly. Plus jsou tam aktuálně |
||||
|
téměř všechny modely, protože je těžké je přesunout jinam. |
||||
|
|
||||
|
**TLDR: Nevšímejte si složky data/ a souborů přímo v kořenové složce.** |
||||
|
Kromě věcí potřebných ke gitu, :doc:`ke spuštění <vyvoj>` a fukci djanga, |
||||
|
dalších drobností, lokální databáze a již zmíněných aplikací jsou tu ``data``, |
||||
|
kde je takový ten obsah webu, co by se měl dát snadno měnit (tudíž musí být v |
||||
|
databázi), tj. statické stránky, menu a obrázky v pozadí menu. Ten je třeba |
||||
|
měnit hlavně na produkci a sekundárně tady (může to dělat i newebař a nechcete |
||||
|
přepsat jeho práci). Vše, co nejsou aplikace je popsáno :doc:`tady <dalsi_soubory>`. |
||||
|
|
||||
|
Základy djanga |
||||
|
-------------- |
||||
|
|
||||
|
|
||||
|
|
||||
|
mamweb je psaný téměř čistě v djangu. Což znamená, že to „co je vidět na stránkách“ |
||||
|
jsou views. |
||||
@ -1,20 +1,184 @@ |
|||||
Lokální vývoj mamwebu |
Lokální vývoj mamwebu |
||||
===================== |
===================== |
||||
Stačí spustit:: |
|
||||
|
Asi hlavní část vývoje většiny webu probíhá lokálně. Každý tak může pracovat na |
||||
## Nahradte svym gimli username |
vlastních úpravách nezávisle na ostatních. |
||||
git clone USER@gimli.ms.mff.cuni.cz:/akce/mam/git/mamweb.git mamweb |
|
||||
cd mamweb |
Potřebné vybavení |
||||
## Instalace je trochu magická, spusť následující posloupnost příkazů: |
------- |
||||
make install_venv |
|
||||
. env/bin/activate |
Tento soupis cílí na Linuxáky. Jistě je |
||||
make install_web |
spousta dalších možností, které zde nejsou postihnuty – poraď se s webaři, |
||||
|
pokud si nejsi jistý. (Speciálně lze nějak vyvíjet na Windows, leč lze často |
||||
## Vygeneruje nejaka testovaci data (spis chuda) |
narazit na odlišné chování od Linuxu.) |
||||
./manage.py testdata |
|
||||
## Nahraje statické stránky, menu a obrázky v pozadí menu |
Motivace cílení na Linux je to, že Gimli je Linuxový stroj, takže je vývojové |
||||
./manage.py loaddata data/* |
prostředí pak podobné produkci a zmenšuje to množství odlišného chování. |
||||
## Spusti testovaci server na http://127.0.0.1:8000/ |
|
||||
./manage.py runserver |
.. TODO: Na dokumentaci odlišného chování (Postgres vs. SQLite, Win vs. Linux, …) |
||||
|
by to asi chtělo výhledově separátní stránku, ale teď píšu tuhle :-) |
||||
Když si lokálně spustíte web, běží na http://127.0.0.1:8000/, admin najdete na http://127.0.0.1:8000/admin/ (admin/admin) Až skončíš s vývojem webu, spusť “deactivate”. Tím zmizí ‘(env)’ ze začátku promptu. |
|
||||
|
Nutné |
||||
|
^^^^ |
||||
|
|
||||
|
- `Git <https://git-scm.com>`_ |
||||
|
- `Python <https://python.org>`_ |
||||
|
|
||||
|
- Ideálně ve verzi 3.9 (to je to, co je aktuálně (2022) na Gimlim) |
||||
|
- Včetně pip-u (na Ubuntu balíček ``python3-pip``), venvu (``python3-venv``) a knihoven pro kompilaci |
||||
|
Cčkových rozšíření (``python3-dev``) |
||||
|
- Knihovna pro práci s PostgreSQL (``libpq-dev``, protože jsou potřeba všechny db backendy) |
||||
|
- Webový prohlížeč |
||||
|
- \*NIXový shell (typicky ``bash``) |
||||
|
|
||||
|
.. TODO: Pokud tu něco chybí, tak to dopiš :-) |
||||
|
|
||||
|
Kromě toho je potřeba mít účet na `Gitee <https://gitea.ks.matfyz.cz>`_, kde |
||||
|
bydlí gitový repozitář s kódem. |
||||
|
|
||||
|
.. tip:: Potřebné balíčky v různých distribucích jsou sepsané v :ref:`tabulce |
||||
|
prerekvizit <Alternativní jména balíčků>`. |
||||
|
|
||||
|
Doporučené |
||||
|
^^^^^^^^^^ |
||||
|
|
||||
|
- Python wheel (možná řeší problémy s potřebou ``-dev`` balíčků…) |
||||
|
- Editor / IDE podporující `Editorconfig <https://editorconfig.org/>`_ |
||||
|
- Uživatelská zkušenost s `produkční verzí webu <https://mam.matfyz.cz>`_ |
||||
|
- Účet v `Kanci <https://kanboard.ledoian.cz>`_ |
||||
|
|
||||
|
.. TODO: A nejspíš další věci, na které jsem si teď nevzpomněl. |
||||
|
|
||||
|
|
||||
|
Zprovoznění |
||||
|
------- |
||||
|
|
||||
|
Nejprve je potřeba stáhnout si repozitář. To se provede příkazem ``git clone |
||||
|
https://gitea.ks.matfyz.cz/mam/mamweb.git``, případně ``git clone |
||||
|
git@gitea.ks.matfyz.cz:mam/mamweb.git``, pokud už máš nahraný SSH klíč na |
||||
|
Giteu. (Obě adresy se dají zkopírovat ze `stránky repozitáře |
||||
|
<https://gitea.ks.matfyz.cz/mam/mamweb>`_.) To vyrobí složku ``mamweb``, přepni |
||||
|
se do ní (``cd mamweb``) |
||||
|
|
||||
|
O zprovoznění webu se stará skript ``make/install_web``, stačí ho spustit. Ten |
||||
|
vytvoří virtualenv (neexistuje-li) a nainstaluje do něj závislosti webu (podle |
||||
|
souboru ``requirements.txt``). |
||||
|
|
||||
|
.. FIXME: Novowebaři zmínka o requirements.txt tady moc nepomůže, to má být na |
||||
|
stránce o celkové stavbě repozitáře a stacku… |
||||
|
|
||||
|
Následně je potřeba 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`` to kdyžtak na konci připomene. |
||||
|
|
||||
|
.. caution:: Zatímco skripty v ``make/`` to nepotřebují, pro použití skriptu |
||||
|
``./manage.py`` (a dalších) 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``. |
||||
|
|
||||
|
Samotný web se spustí třeba pomocí ``make/run``, nebo ekvivalentně |
||||
|
``./manage.py runserver`` a pak je vidět na `<http://127.0.0.1:8000>`_. |
||||
|
|
||||
|
Časté problémy |
||||
|
^^^^^^ |
||||
|
|
||||
|
- ``make/install_web`` vypíše ``Error: pg_config executable not found.``: |
||||
|
Chybí ``libpq-dev`` |
||||
|
- Chybová hláška obsahuje ``#include <Python.h>``: chybí ``python3-dev`` |
||||
|
- Na webu není vidět meníčko: spusť ``./manage.py loaddata data/*`` |
||||
|
- ``locale.Error: unsupported locale setting``: Chybí podpora pro příslušný |
||||
|
jazyk ve tvém systému. Odkomentuj příslušnou lokalizaci v ``/etc/locale.gen`` |
||||
|
a spusť ``locale-gen`` jako root, tím se to spraví. |
||||
|
|
||||
|
S dalšími problémy se zkus obrátit na další webaře, třeba někdo bude vědět :-) |
||||
|
|
||||
|
Příkazy pro ovládání webu |
||||
|
------- |
||||
|
|
||||
|
Příkazy se dělí do několika skupin. Některé souvisí přímo s webem, Djangem, |
||||
|
databází a podobně, ty typicky používají ``./manage.py``. Skripty pro |
||||
|
obhospodařování repozitáře a webu „zvenku“ typicky bydlí ve složce ``make/``. |
||||
|
Ostatní skripty jsou na náhodných místech :-) |
||||
|
|
||||
|
Tady jsou rozebrány jen příkazy relevantní pro lokální web a univerzálně |
||||
|
užitečné, ostatní najdeš v :ref:`Skripty pro práci s repozitářem`. |
||||
|
|
||||
|
Make skripty |
||||
|
^^^^^^^ |
||||
|
|
||||
|
- ``make/install_web`` nainstaluje závislosti webu |
||||
|
- ``make/run`` spustí web (ekvivalentní s ``./manage.py runserver``) |
||||
|
- ``make/schema`` nakreslí schéma vazeb modelů (může se hodit pro referenci a představu) |
||||
|
- ``make/test`` spustí testy (ale moc jich zatím není; ekvivalentní s ``./manage.py test``) |
||||
|
- ``make/sync_prod_flatpages`` stáhne statické stránky z produkčního webu a |
||||
|
uloží je do souboru v gitu, což umožňuje jejich verzování |
||||
|
|
||||
|
Manage.py skripty |
||||
|
^^^^^ |
||||
|
|
||||
|
.. note:: Je potřeba je spouštět ve virtuálním prostředí, viz výše. |
||||
|
|
||||
|
Všechny skripty kdyžtak mají ``--help``, dá se tak zjistit, co všechno umějí. |
||||
|
|
||||
|
- ``./manage.py testdata`` vygeneruje spíše chudá testovací data, aby bylo na |
||||
|
čem testovat web. |
||||
|
- ``./manage.py loaddata <soubor/y>`` nahraje data ze souborů do databáze |
||||
|
- ``./manage.py dumpdata <model>`` naopak z databáze vyrobí textovou reprezentaci |
||||
|
- ``./manage.py shell`` spustí interaktivní pythoní shell, ze kterého lze |
||||
|
interagovat s webem / Djangem. |
||||
|
- ``./manage.py dbshell`` spustí databázový shell (typicky používá SQL) |
||||
|
|
||||
|
- ``./manage.py makemigrations`` vyrobí popis migrací, ``./manage.py migrate`` |
||||
|
je spustí, ``showmigrations`` ukáže, které migrace jsou aplikované a které |
||||
|
ne. |
||||
|
- ``./manage.py runserver_plus`` spouští o něco lepší vývojový server (ale |
||||
|
nikdy jsem asi ty lepší featury nepoužil) |
||||
|
|
||||
|
Může se hodit vědět, že spuštění ``./manage.py`` bez parametrů vypíše seznam |
||||
|
všech příkazů, které lze spustit. |
||||
|
|
||||
|
Dokumentace djangových příkazů je v `dokumentaci Djanga |
||||
|
<https://docs.djangoproject.com/en/3.2/ref/django-admin/#available-commands>`_ |
||||
|
|
||||
|
Ostatní užitečné příkazy |
||||
|
^^^^^ |
||||
|
|
||||
|
- ``git status`` je univerzální nápověda na aktuální stav repozitáře a co s tím |
||||
|
lze dělat. |
||||
|
- ``git clean -fxd`` smaže všechny soubory, které nejsou uložené v gitu (včetně |
||||
|
ignorovaných). **Nebezpečný příkaz**, zamysli se, než ho spustíš |
||||
|
|
||||
|
Specifika lokálního webu |
||||
|
------- |
||||
|
|
||||
|
Lokální uživatelé |
||||
|
^^^^^^^ |
||||
|
|
||||
|
Přihlašovací údaje jsou psány jako ``login:heslo`` |
||||
|
|
||||
|
- Superuživatel: ``admin:admin`` |
||||
|
- Orgovské účty: ``o:o``, ``o1:o`` až ``o3:o`` |
||||
|
- Řešitelské účty: ``r:r``, ``r1:r`` až ``r3:r`` |
||||
|
|
||||
|
Všechny tyto účty jsou (?) svázané s nějakými fiktivními osobami, není ale zřejmé se |
||||
|
kterými, budeš to muset vyzkoušet a pak tady zdokumentovat :-) |
||||
|
|
||||
|
E-maily |
||||
|
^^^^^ |
||||
|
|
||||
|
Posílání e-mailů se lokálně dá zkoušet, e-mail se vypíše do terminálu, kde je |
||||
|
web spuštěn (e.g. pomocí ``make/run``). |
||||
|
|
||||
|
Pruhy |
||||
|
^^^^ |
||||
|
|
||||
|
To, že má lokální web po stranách zelené pruhy je normální a správně, slouží to |
||||
|
k vizuálnímu odlišení lokálního webu. |
||||
|
|
||||
|
.. TODO: Mít někde popis všech tří instancí a tady na něj pak odkázat. |
||||
|
.. - Tahák k používání gitových větví: do workflow, ne sem… |
||||
|
.. - Užitečné odkazy – kam se kouknout |
||||
|
(dohledávání views podle URL, settings_*, ) |
||||
|
.. - Zpříjemnění práce (ssh-klíče, tea, --help, …) |
||||
|
|
||||
|
|||||
@ -0,0 +1,97 @@ |
|||||
|
Závislosti webu |
||||
|
@@@@@@@@@@@@@@@ |
||||
|
|
||||
|
Web ke svému běhu potřebuje různé další programy. Tahle stránka se snaží je pokrýt. |
||||
|
|
||||
|
Stránka je koncipována jako odrážkový seznam balíčků pro Ubuntu s případnými |
||||
|
komentáři, na konci stránky jsou uvedena :ref:`jména balíčků <Alternativní jména |
||||
|
balíčků>` v různých dalších distribucích. (Seznam mj. cílí na lokální |
||||
|
rozchození, proto popisuji Ubuntu a ne Debian. I tak se ale snažíme popsat web |
||||
|
v úplnosti.) |
||||
|
|
||||
|
.. I use Arch, btw. |
||||
|
|
||||
|
|
||||
|
Základ webu |
||||
|
=========== |
||||
|
|
||||
|
- ``python3`` – Ideálně Python 3.9, jenž je na Gimlim |
||||
|
- ``python3-pip`` pro instalaci dalších Pythoních balíčků podle ``requirements.txt`` |
||||
|
- ``python3-venv`` |
||||
|
- ``gcc`` – kompilace Pythoních knihoven ze zdrojových distribucí (sdist), možná (neotestováno) jde jako alternativu použít ``python3-wheel`` a stahovat bdists |
||||
|
- ``python3-dev`` – taktéž |
||||
|
- ``libpq-dev`` do třetice… |
||||
|
- ``ghostscript`` TODO konverze PDF v korekturovátku |
||||
|
- ``pdflatex`` FIXME! generování obálek a stvrzenek |
||||
|
- ``git`` – používán :ref:`Make skripty` |
||||
|
- ``locales`` pro české formáty |
||||
|
|
||||
|
Nasazení na produkci / testweb |
||||
|
============================== |
||||
|
|
||||
|
(nejsou nutně potřeba k provozu lokální instance) |
||||
|
|
||||
|
- ``rsync`` |
||||
|
- ``pg_utils`` FIXME |
||||
|
- ``htpasswd`` FIXME – aby testweb nepoužívali náhodní kolemjdoucí |
||||
|
- ``postgresql-server`` TODO |
||||
|
- ``acl`` pro nastavování práv přes ``setfacl`` |
||||
|
|
||||
|
Pro testweb je potřeba i všechno pro :ref:`dokumentaci <Dokumentace>`, vizte níž. |
||||
|
|
||||
|
Předpokládá se nasazení v uWSGI pod Nginxem a služba běžící pod systemd, nicméně to už je spíš záležitost infrastruktury a ne specifikum mamwebu. |
||||
|
|
||||
|
Dokumentace |
||||
|
=========== |
||||
|
|
||||
|
- ``make`` pro zbuildění |
||||
|
- Pythoní balíčky podle příslušné části ``requirements.txt`` |
||||
|
|
||||
|
Vývojové nástroje |
||||
|
================= |
||||
|
|
||||
|
(Nejsou nezbytně nutné, ale předpokládáme jejich užitečnost. Mohou se hodit i na produkci.) |
||||
|
|
||||
|
- ``psql`` TODO pro manuální dotazy do PostgreSQL |
||||
|
- ``sqlite3`` TODO totéž pro SQLite3 |
||||
|
- ``ssh`` |
||||
|
- ``graphviz`` pro vygenerování schématu |
||||
|
- ``rsync`` |
||||
|
- ``ipython3`` – hezčí interaktivní shell (stačí z ``requirements.txt``) |
||||
|
|
||||
|
Potenciální usnadnění života |
||||
|
============================ |
||||
|
|
||||
|
(Úplně zbytečné, ale sdílíme pozitivní zkušenosti :-)) |
||||
|
|
||||
|
- ``tea`` – CLI klient pro Giteu, aby člověk nepotřeboval otevírat web pro založení PR |
||||
|
|
||||
|
|
||||
|
Alternativní jména balíčků |
||||
|
========================== |
||||
|
|
||||
|
Různé distribuce balí SW různě, takže to, co je v jedné distribuci jeden |
||||
|
balíček může být v jiné rozděleno do víc. Pro usnadnění nasazení je tady |
||||
|
přehled známých alternativních jmen. |
||||
|
|
||||
|
TODO: tabulka není úplná. Pokud na něco narazíte, tak ji prosím doplňte. |
||||
|
|
||||
|
.. admonition:: Jak se pozná, že web funguje, pro účely tabulky? |
||||
|
|
||||
|
Na čistém repozitáři (``git clean -fxd``) a čistém systému spouštíme |
||||
|
``make/init_local``. Když to spadne, tak do tabulky zapíšeme, co jsme |
||||
|
přiinstalovali. Protože nefunguje synchronizace flatpages (nemáme SSH klíč), |
||||
|
``make/init_local`` sestřelíme při pokusu o synchronizaci a vyzkoušíme, že |
||||
|
``make/test`` spustí testy. |
||||
|
|
||||
|
.. Grafické tabulky (grid-tables, simple-tables) jsou strašný porod vyrábět, dlabu na to a cpu to do CSV… |
||||
|
|
||||
|
.. csv-table:: Prerekvizity v jednotlivých distribucích |
||||
|
:header: Distribuce / OS, Repozitář s Py3.9, venv, py knihovny, PostgreSQL knihovna, poznámky |
||||
|
|
||||
|
Ubuntu 22.10, ??, ``python3-venv``, ``python3-dev``, ``libpq-dev``, "Je potřeba zapnout zdroj ``universe`` a nainstalovat kompilátor C (``gcc``)?" |
||||
|
Linux Mint 21, ??, ``python3-venv``, ``python3-dev``, ``libpq-dev``, "" |
||||
|
Archlinux 2022.11.01, AUR, vestavěný, vestavěné, ``postgresql-libs``, "Je potřeba céčkový kompilátor (``gcc``)" |
||||
|
openSUSE Leap 15.4, oficiální (``python39``), předinstalovaný?, ``python39-devel``, ??FIXME!!, "Výchozí verze pythonu je 3.6 a ta je moc stará, potřeba instalovat ``gcc``. Nevím jak sehnat pg_config." |
||||
|
Debian 11, "oficiální, výchozí", ??, ??, ??, "Určitě to tam rozběhat jde, protože Gimli. Nejspíš bude relativně podobné Ubuntu." |
||||
|
|
||||
@ -1,25 +0,0 @@ |
|||||
======== |
|
||||
| TODO | |
|
||||
|======| |
|
||||
|
|
||||
Aktualni |
|
||||
* co s titulni fotkou |
|
||||
* do CSS |
|
||||
* nahledy |
|
||||
* nastylovat tabulku s nahledy |
|
||||
* komentare uz na nahledy? |
|
||||
* detail |
|
||||
* nahledy pred a po |
|
||||
* opravit prechodove sipky |
|
||||
* vyrobit prechodove sipky ve M&M-stylu |
|
||||
|
|
||||
Dlouhodobe |
|
||||
* sipky na prechazeni mezi fotkami |
|
||||
* hromadne PRIDANI fotek do jiz existujici galerie |
|
||||
|
|
||||
Fylozoficke |
|
||||
* zvolit velikosti velke a male fotky |
|
||||
* je potreba i jine razeni nez automaticky podle casu nebo staci podgalerie? |
|
||||
* napr. dve hry na dvou ruznych mistech ve stejny cas |
|
||||
* fotky od ucastniku ze hry (skupinky se pohybuji ve stejny cas, ale maji sled fotek) -- nestaci to pripadne vrazit do podgalerii? |
|
||||
|
|
||||
@ -1,47 +0,0 @@ |
|||||
# -*- coding: utf-8 -*- |
|
||||
|
|
||||
from autocomplete_light import shortcuts as autocomplete_light |
|
||||
|
|
||||
from .models import Obrazek, Galerie |
|
||||
from .views import cesta_od_korene |
|
||||
|
|
||||
|
|
||||
class ObrazekAutocomplete(autocomplete_light.AutocompleteModelBase): |
|
||||
|
|
||||
model = Obrazek |
|
||||
search_fields = ['nazev', 'popis'] |
|
||||
split_words = True |
|
||||
limit_choices = 15 |
|
||||
attrs = { |
|
||||
# This will set the input placeholder attribute: |
|
||||
'placeholder': u'Obrázek', |
|
||||
# This will set the yourlabs.Autocomplete.minimumCharacters |
|
||||
# options, the naming conversion is handled by jQuery |
|
||||
'data-autocomplete-minimum-characters': 1, |
|
||||
} |
|
||||
|
|
||||
choice_html_format = ''' |
|
||||
<span class="block" data-value="{}"> |
|
||||
<span class="block"> |
|
||||
{} |
|
||||
<span class="block">{}</span> |
|
||||
</span> |
|
||||
</span> |
|
||||
''' |
|
||||
|
|
||||
def choice_label(self, obrazek): |
|
||||
cesta = "/".join(g.nazev for g in cesta_od_korene(obrazek.galerie)) |
|
||||
popis = "{}<br>".format(obrazek.popis) if obrazek.popis else "" |
|
||||
return '{}<br>{}{}'.format(obrazek.nazev, popis, cesta) |
|
||||
|
|
||||
def choice_html(self, obrazek): |
|
||||
"""Vrátí kus html i s obrázkem, které se pak ukazuje v nabídce""" |
|
||||
return self.choice_html_format.format(self.choice_value(obrazek), |
|
||||
obrazek.obrazek_maly_tag(), self.choice_label(obrazek)) |
|
||||
|
|
||||
widget_attrs={ |
|
||||
'data-widget-maximum-values': 15, |
|
||||
'class': 'modern-style', |
|
||||
} |
|
||||
|
|
||||
autocomplete_light.register(ObrazekAutocomplete) |
|
||||
@ -0,0 +1,13 @@ |
|||||
|
# Generated by Django 4.2.11 on 2024-04-30 21:53 |
||||
|
|
||||
|
from django.db import migrations |
||||
|
|
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('galerie', '0010_auto_20200819_0947'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
] |
||||
@ -0,0 +1,20 @@ |
|||||
|
# Generated by Django 4.2.11 on 2024-05-01 13:07 |
||||
|
|
||||
|
from django.db import migrations, models |
||||
|
import django.db.models.deletion |
||||
|
|
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('soustredeni', '0001_split_from_seminar'), |
||||
|
('galerie', '0011_pre_split_soustredeni'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
migrations.AlterField( |
||||
|
model_name='galerie', |
||||
|
name='soustredeni', |
||||
|
field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to='soustredeni.soustredeni'), |
||||
|
), |
||||
|
] |
||||
@ -0,0 +1,14 @@ |
|||||
|
# Generated by Django 4.2.11 on 2024-05-01 13:35 |
||||
|
|
||||
|
from django.db import migrations |
||||
|
|
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('galerie', '0012_soustredeni_relink'), |
||||
|
('soustredeni', '0003_post_split_soustredeni'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
] |
||||
@ -0,0 +1,186 @@ |
|||||
|
@charset "utf-8"; /* vynuť utf-8 */ |
||||
|
|
||||
|
/* Galerie */ |
||||
|
|
||||
|
|
||||
|
/* velká fotka */ |
||||
|
/* zmenšování spolu s oknem prohlížeče */ |
||||
|
.galerie .obrazek, .titulni_obrazek { |
||||
|
max-width: 100%; |
||||
|
height: auto; |
||||
|
width: auto\9; /* ie8 */ |
||||
|
} |
||||
|
|
||||
|
.predchozi_obrazek{ |
||||
|
position: absolute; |
||||
|
z-index: 1; |
||||
|
width: 33%; |
||||
|
height: 100%; |
||||
|
left: 0; |
||||
|
top: 0; |
||||
|
} |
||||
|
.predchozi_obrazek:hover{ |
||||
|
background-image: url("/static/galerie/prvky/predchozi.svg"); |
||||
|
filter: drop-shadow(0px 5px 5px rgba(0, 0, 0, 0.4)); |
||||
|
background-position: left center; |
||||
|
background-repeat: no-repeat; |
||||
|
} |
||||
|
.dalsi_obrazek{ |
||||
|
position: absolute; |
||||
|
z-index: 1; |
||||
|
width: 33%; |
||||
|
height: 100%; |
||||
|
left: 67%; |
||||
|
top: 0; |
||||
|
} |
||||
|
.dalsi_obrazek:hover{ |
||||
|
background-image: url("/static/galerie/prvky/dalsi.svg"); |
||||
|
filter: drop-shadow(0px 5px 5px rgba(0, 0, 0, 0.4)); |
||||
|
background-position: right center; |
||||
|
background-repeat: no-repeat; |
||||
|
} |
||||
|
|
||||
|
.galerie { |
||||
|
position: relative; |
||||
|
text-align: center; |
||||
|
margin: 20px auto 0 auto; |
||||
|
} |
||||
|
|
||||
|
.galerie h1 { |
||||
|
text-align: center; |
||||
|
} |
||||
|
|
||||
|
.galerie_hlavicka { |
||||
|
margin: 30px auto 30px auto; |
||||
|
} |
||||
|
|
||||
|
.popis { |
||||
|
margin: 10px 10px 30px 0px; |
||||
|
text-align: center; |
||||
|
} |
||||
|
|
||||
|
#nahoru { |
||||
|
text-align: center; |
||||
|
} |
||||
|
|
||||
|
/* titulní obrázek hlavní galerie soustředění */ |
||||
|
|
||||
|
.galerie_nahledy{ |
||||
|
/*margin: 1em 0;*/ |
||||
|
margin: auto; |
||||
|
padding: 10px; |
||||
|
text-align: center; |
||||
|
overflow: auto; |
||||
|
} |
||||
|
|
||||
|
.galerie_nahledy img { |
||||
|
margin: 10px; |
||||
|
} |
||||
|
|
||||
|
.galerie_nahledy div.navigace { |
||||
|
display: inline-block; |
||||
|
} |
||||
|
|
||||
|
.galerie_nahled, .podgalerie_nahled { /* frame */ |
||||
|
display: block; |
||||
|
position: relative; |
||||
|
float: left; |
||||
|
width: 200px; |
||||
|
height: 200px; |
||||
|
text-align: center; |
||||
|
border: solid; |
||||
|
border-width: 1px; |
||||
|
border-radius: 4px; |
||||
|
border-color: var(--svetla-oranzova); |
||||
|
background-color: var(--barva-pozadi); |
||||
|
white-space: nowrap; |
||||
|
margin: 10px; |
||||
|
font-weight: bold; |
||||
|
} |
||||
|
|
||||
|
.galerie_nahled:hover, .podgalerie_nahled:hover { |
||||
|
background-color: var(--svetla-oranzova); |
||||
|
filter: drop-shadow(0px 5px 5px rgba(0, 0, 0, 0.4)); |
||||
|
color: var(--tmava-oranzova); |
||||
|
} |
||||
|
|
||||
|
.vystredeno{ /* helper */ |
||||
|
display: inline-block; |
||||
|
height: 100%; |
||||
|
vertical-align: middle; |
||||
|
} |
||||
|
|
||||
|
.galerie_nahled img { |
||||
|
vertical-align: middle; |
||||
|
max-height: 180px; |
||||
|
max-width: 180px; |
||||
|
} |
||||
|
|
||||
|
.galerie_nahled div { |
||||
|
position: absolute; |
||||
|
bottom: 0px; |
||||
|
width: 100%; |
||||
|
text-align: center; |
||||
|
} |
||||
|
|
||||
|
.podgalerie_nahled img { |
||||
|
margin-top: 20px; |
||||
|
margin-bottom: 15px; |
||||
|
max-height: 125px; |
||||
|
max-width: 167px; |
||||
|
} |
||||
|
|
||||
|
.podgalerie_nahled .nazev_galerie { |
||||
|
position: absolute; |
||||
|
width: 100%; |
||||
|
top: 160px; |
||||
|
} |
||||
|
|
||||
|
|
||||
|
/* Odkazy na předchozí a následující podgalerii */ |
||||
|
.galerie_predchozi_nasledujici { |
||||
|
overflow: auto; |
||||
|
margin: 10px auto 10px auto; |
||||
|
} |
||||
|
|
||||
|
.galerie_predchozi_nasledujici .predchozi { |
||||
|
float: left; |
||||
|
} |
||||
|
|
||||
|
.galerie_predchozi_nasledujici .nasledujici { |
||||
|
float: right; |
||||
|
} |
||||
|
|
||||
|
/* posune kotvu obrázku v galerii o oranžový pruh dolu, aby se pod ním obrázek neschovával */ |
||||
|
/* https://stackoverflow.com/questions/10732690/offsetting-an-html-anchor-to-adjust-for-fixed-header */ |
||||
|
.kotva_obrazku { |
||||
|
position: absolute; |
||||
|
width: 0; |
||||
|
height: 55px; /* viz #title */ |
||||
|
margin-top: -55px; /* viz #title */ |
||||
|
} |
||||
|
@media(max-width: 860px) { |
||||
|
.kotva_obrazku { |
||||
|
height: 3em; /* #FIXME nemám páru, jak zjistit výšku toho elementu */ |
||||
|
margin-top: -3em; /* #FIXME */ |
||||
|
} |
||||
|
} |
||||
|
|
||||
|
|
||||
|
/* plus a minus tlacitka */ |
||||
|
.mam-org-only-galerie { |
||||
|
background: var(--orgovska-svetla-fialova); |
||||
|
padding: 10px; |
||||
|
margin: 10px 10px 10px -20px; |
||||
|
border: #333 2px dashed; |
||||
|
float: left; |
||||
|
} |
||||
|
|
||||
|
.mam-org-only-galerie a{ |
||||
|
padding: 3px 5px; |
||||
|
margin: 5px; |
||||
|
border-radius: 20px; |
||||
|
background-color: var(--tmava-oranzova);; |
||||
|
color: var(--barva-pozadi); |
||||
|
float: left; |
||||
|
} |
||||
@ -0,0 +1,6 @@ |
|||||
|
{% extends "base.html" %} |
||||
|
{% load static %} |
||||
|
|
||||
|
{% block custom_css %} |
||||
|
<link href="{% static 'css/galerie.css' %}?version=1" rel="stylesheet"> |
||||
|
{% endblock %} |
||||
@ -1,8 +1,6 @@ |
|||||
""" |
|
||||
Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace. |
|
||||
""" |
|
||||
from django.apps import AppConfig |
from django.apps import AppConfig |
||||
|
|
||||
|
|
||||
class HeaderFotkyConfig(AppConfig): |
class HeaderFotkyConfig(AppConfig): |
||||
name = 'header_fotky' |
name = 'header_fotky' |
||||
|
verbose_name = 'Fotky v záhlaví' |
||||
|
|||||
@ -1,11 +0,0 @@ |
|||||
- korektura potrebuje reakci |
|
||||
+ komentáře fixně na username |
|
||||
- používat skutečné jméno? |
|
||||
- vyžádat pozornost autora obsahu |
|
||||
- zvednout upload limit na 5MB |
|
||||
- sbalit a rozbalit korekturu |
|
||||
- nahrávání jiných věcí než PDF - kontrolovat? |
|
||||
- stylování |
|
||||
- seznam PDF - co zobrazovat? |
|
||||
|
|
||||
|
|
||||
@ -0,0 +1,18 @@ |
|||||
|
# Generated by Django 2.2.28 on 2022-12-05 19:14 |
||||
|
|
||||
|
from django.db import migrations, models |
||||
|
|
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('korektury', '0018_korekturovanepdf_poslat_mail'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
migrations.AlterField( |
||||
|
model_name='korekturovanepdf', |
||||
|
name='nazev', |
||||
|
field=models.CharField(help_text='Název (např. 22.1 verze 4) korekturovaného PDF', max_length=50, verbose_name='název PDF'), |
||||
|
), |
||||
|
] |
||||
@ -0,0 +1,18 @@ |
|||||
|
# Generated by Django 2.2.28 on 2023-06-19 19:38 |
||||
|
|
||||
|
from django.db import migrations, models |
||||
|
|
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('korektury', '0019_auto_20221205_2014'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
migrations.AlterField( |
||||
|
model_name='korekturovanepdf', |
||||
|
name='nazev', |
||||
|
field=models.CharField(help_text='Název (např. `22.1 | analyza v4` nebo `propagace | letacek v0`) korekturovaného PDF', max_length=50, verbose_name='název PDF'), |
||||
|
), |
||||
|
] |
||||
@ -0,0 +1,13 @@ |
|||||
|
# Generated by Django 4.2.8 on 2024-03-12 20:24 |
||||
|
|
||||
|
from django.db import migrations |
||||
|
|
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('korektury', '0020_lepsi_popis_nazvu_PDF_v_adminu'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
] |
||||
@ -0,0 +1,30 @@ |
|||||
|
# Generated by Django 4.2.11 on 2024-03-19 21:35 |
||||
|
|
||||
|
from django.db import migrations, models |
||||
|
import django.db.models.deletion |
||||
|
|
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('personalni', '0003_initial'), |
||||
|
('korektury', '0021_auto_20240312_2124'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
migrations.AlterField( |
||||
|
model_name='komentar', |
||||
|
name='autor', |
||||
|
field=models.ForeignKey(blank=True, help_text='Autor komentáře', null=True, on_delete=django.db.models.deletion.SET_NULL, to='personalni.organizator'), |
||||
|
), |
||||
|
migrations.AlterField( |
||||
|
model_name='korekturovanepdf', |
||||
|
name='org', |
||||
|
field=models.ForeignKey(blank=True, default=None, help_text='Zodpovědný organizátor za obsah', null=True, on_delete=django.db.models.deletion.SET_NULL, to='personalni.organizator'), |
||||
|
), |
||||
|
migrations.AlterField( |
||||
|
model_name='oprava', |
||||
|
name='autor', |
||||
|
field=models.ForeignKey(blank=True, help_text='Autor opravy', null=True, on_delete=django.db.models.deletion.SET_NULL, to='personalni.organizator'), |
||||
|
), |
||||
|
] |
||||
@ -0,0 +1,14 @@ |
|||||
|
# Generated by Django 4.2.11 on 2024-03-26 21:25 |
||||
|
|
||||
|
from django.db import migrations |
||||
|
|
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('korektury', '0022_alter_komentar_autor_alter_korekturovanepdf_org_and_more'), |
||||
|
('personalni', '0005_personalni_post_migrate'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
] |
||||
@ -0,0 +1,41 @@ |
|||||
|
# Generated by Django 4.2.13 on 2024-06-11 23:53 |
||||
|
|
||||
|
from django.db import migrations, models |
||||
|
|
||||
|
def pridej_orgy(apps, schema_editor): |
||||
|
PDF = apps.get_model('korektury', 'KorekturovanePDF') |
||||
|
for pdf in PDF.objects.all(): # Tohle by asi mělo jít udělat pomocí update, ale moc práce a rychlé hledání taky nepomohlo. |
||||
|
if pdf.org is not None: pdf.orgove.add(pdf.org) |
||||
|
pdf.save() # ig? |
||||
|
|
||||
|
def vyber_orga(apps, schema_editor): |
||||
|
PDF = apps.get_model('korektury', 'KorekturovanePDF') |
||||
|
for pdf in PDF.objects.all(): |
||||
|
orgove = pdf.orgove.all() |
||||
|
if len(orgove) > 1: |
||||
|
raise migrations.exceptions.IrreversibleError(f'PDF {pdf.id} má víc než jednoho zodpovědného orga, nejde odmigrovat na verzi, která umí jen jednoho.') |
||||
|
if len(orgove) == 0: |
||||
|
pdf.org = None |
||||
|
else: |
||||
|
pdf.org = orgove[0] |
||||
|
pdf.save() |
||||
|
|
||||
|
class Migration(migrations.Migration): |
||||
|
|
||||
|
dependencies = [ |
||||
|
('personalni', '0011_osloveni_vsechny_choices'), |
||||
|
('korektury', '0023_personalni_post_migrate'), |
||||
|
] |
||||
|
|
||||
|
operations = [ |
||||
|
migrations.AddField( |
||||
|
model_name='korekturovanepdf', |
||||
|
name='orgove', |
||||
|
field=models.ManyToManyField(blank=True, default=None, help_text='Zodpovědní organizátoři za obsah (chodí jim maily o nových korekturách)', to='personalni.organizator'), |
||||
|
), |
||||
|
migrations.RunPython(pridej_orgy, vyber_orga), |
||||
|
migrations.RemoveField( |
||||
|
model_name='korekturovanepdf', |
||||
|
name='org', |
||||
|
), |
||||
|
] |
||||
@ -1,3 +0,0 @@ |
|||||
from django.test import TestCase |
|
||||
|
|
||||
# Create your tests here. |
|
||||
@ -0,0 +1,8 @@ |
|||||
|
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. |
||||
|
Pro detaily a nápovědu si prosím přečti dokumentaci v docs/vyvoj.rst. |
||||
|
|
||||
|
TL;DR: Web vyrobíš pomocí následující posloupnosti příkazů: |
||||
|
make/init_local |
||||
|
make/run |
||||
|
a web potom najdeš na <http://127.0.0.1:8000> |
||||
|
|
||||
@ -0,0 +1,31 @@ |
|||||
|
#!/bin/bash |
||||
|
|
||||
|
set -exuo pipefail |
||||
|
. make/lib.sh |
||||
|
|
||||
|
gimli_only |
||||
|
only_in_directory "$TESTWEB" |
||||
|
|
||||
|
CURRENT_BRANCH="$(git branch --show-current)" |
||||
|
BRANCH="${1:-$CURRENT_BRANCH}" |
||||
|
|
||||
|
safe_checkout_branch "$BRANCH" |
||||
|
|
||||
|
# Teď máme správnou větev, jdeme vše nainstalovat |
||||
|
install_everything |
||||
|
systemctl --user restart mamweb-test.service |
||||
|
|
||||
|
# Přihlášení |
||||
|
htpasswd -bc .htpasswd test lisakjelisak |
||||
|
setfacl -m u:www-data:r .htpasswd |
||||
|
|
||||
|
# Build dokumentace |
||||
|
ensure_venv |
||||
|
( |
||||
|
cd docs |
||||
|
make html |
||||
|
) |
||||
|
# Oprava práv k dokumentaci |
||||
|
setfacl -m u:www-data:x . docs docs/_build |
||||
|
setfacl -R -m u:www-data:rX docs/_build/html |
||||
|
setfacl -R -m default:u:www-data:rX docs/_build/html |
||||
@ -0,0 +1,25 @@ |
|||||
|
#!/bin/bash |
||||
|
|
||||
|
set -exuo pipefail |
||||
|
. make/lib.sh |
||||
|
|
||||
|
gimli_only |
||||
|
only_in_directory "$PRODWEB" |
||||
|
|
||||
|
CURRENT_BRANCH="$(git branch --show-current)" |
||||
|
BRANCH="${1:-$CURRENT_BRANCH}" |
||||
|
|
||||
|
if test "$BRANCH" != master |
||||
|
then |
||||
|
echo "Pozor, nasazuješ na produkci větev, která není master ($BRANCH), chceš pokračovat? Pokud ne, sestřel tento skript." |
||||
|
read |
||||
|
fi |
||||
|
|
||||
|
# Záloha DB |
||||
|
( cd -P .. && ./backup_prod_db.sh ) |
||||
|
|
||||
|
safe_checkout_branch "$BRANCH" |
||||
|
|
||||
|
# Teď máme správnou větev, jdeme vše nainstalovat |
||||
|
install_everything |
||||
|
systemctl --user restart mamweb-prod.service |
||||
@ -0,0 +1,11 @@ |
|||||
|
#!/bin/bash |
||||
|
|
||||
|
set -exuo pipefail |
||||
|
. make/lib.sh |
||||
|
|
||||
|
make/install_web |
||||
|
ensure_venv |
||||
|
./manage.py testdata |
||||
|
./manage.py loaddata data/* |
||||
|
#make/sync_prod_flatpages |
||||
|
./manage.py load_org_permissions deploy_v2/admin_org_prava.json |
||||
@ -0,0 +1 @@ |
|||||
|
install_web |
||||
@ -0,0 +1,16 @@ |
|||||
|
#!/bin/bash |
||||
|
|
||||
|
set -exuo pipefail |
||||
|
. make/lib.sh |
||||
|
|
||||
|
ensure_venv |
||||
|
|
||||
|
# Aktualizace toolchainu |
||||
|
pip install --upgrade pip setuptools |
||||
|
# Instalace závislostí webu |
||||
|
pip install -r requirements.txt --upgrade |
||||
|
|
||||
|
# XXX: Připomínka z původního Makefile: |
||||
|
echo 'Pro vygenerování tesdat spusť ./manage.py testdata |
||||
|
Po vygenerování testdat spusť ./manage.py loaddata data/*, ať máš menu a další modely |
||||
|
Pro synchronizaci flatpages spusť make/sync_prod_flatpages' |
||||
@ -0,0 +1,115 @@ |
|||||
|
#!/bin/false Tohle je knihovna, nemá se spouštět, ale načítat pomocí source(1) nebo '.' |
||||
|
|
||||
|
PYTHON="${PYTHON:-python3}" |
||||
|
VENV="${VENV:-${PYTHON} -m venv}" |
||||
|
VENV_PATH="${VENV_PATH:-env}" |
||||
|
BRANCH="${BRANCH:-master}" |
||||
|
|
||||
|
REPO="${REPO:-git@gitea.ks.matfyz.cz:mam/mamweb.git}" |
||||
|
UPSTREAM_REMOTE='origin' |
||||
|
GIMLI='gimli.ms.mff.cuni.cz' |
||||
|
GIMLI_LOGIN="mam-web@$GIMLI" |
||||
|
# Skutečné cesty, jak je vrátí `realpath` |
||||
|
PRODWEB="/aux/akce/mam/www/mamweb-prod" |
||||
|
TESTWEB="/aux/akce/mam/www/mamweb-test" |
||||
|
|
||||
|
function die { |
||||
|
echo "$@" >&2 |
||||
|
exit 1 |
||||
|
} |
||||
|
|
||||
|
trap 'echo Něco se nepovedlo :-/' ERR |
||||
|
|
||||
|
# Vždycky chceme zajistit, že běžíme z rootu repozitáře |
||||
|
# TODO: chceme? Nechceme naopak umět to spouštět odkudkoliv, aspoň u většiny targetů? |
||||
|
test -e '.git' || die "Make skript spuštěn ve špatné složce, spusť ho z kořenového adresáře repozitáře." |
||||
|
|
||||
|
function ensure_venv { |
||||
|
test -f "$VENV_PATH/bin/activate" || $VENV "$VENV_PATH" |
||||
|
. "$VENV_PATH/bin/activate" |
||||
|
# To ale není všechno Horste – ten venv nemusí fungovat, chceme to ověřit a případně spadnout. |
||||
|
local SPRAVNA_CESTA="$(readlink -f "$VENV_PATH/bin/python")" |
||||
|
local SKUTECNA_CESTA="$(readlink -f "$(which python)")" |
||||
|
test "$SPRAVNA_CESTA" == "$SKUTECNA_CESTA" || die "Venv asi nefunguje. Prosím smaž si ho a zkus to znovu." |
||||
|
python -c 'print()' > /dev/null || die "Python ve venvu je rozbitý. Prosím smaž venv a zkus to znovu." |
||||
|
} |
||||
|
|
||||
|
function ensure_web_installed { |
||||
|
ensure_venv |
||||
|
python -c 'import django; print(django.__version__)' > /dev/null && return |
||||
|
echo >&2 "POZOR: Web nevypadá nainstalovaně, instaluji." |
||||
|
make/install_web |
||||
|
} |
||||
|
|
||||
|
function gimli_only { |
||||
|
# Rovnou zkontrolujeme i uživatele |
||||
|
if test "$HOSTNAME" != gimli -o "$USER" != mam-web |
||||
|
then |
||||
|
echo "Tento příkaz se má spouštět na gimlim, chceš pokračovat? Pokud ne, sestřel tento skript." |
||||
|
read |
||||
|
fi |
||||
|
} |
||||
|
|
||||
|
function only_in_directory { |
||||
|
local DIR="$1" |
||||
|
local CURRENT="$(readlink -f .)" |
||||
|
if test "$CURRENT" != "$DIR" |
||||
|
then |
||||
|
echo "Tento příkaz se má spouštět ve složce $DIR, chceš pokračovat? Pokud ne, sestřel tento skript." |
||||
|
read |
||||
|
fi |
||||
|
} |
||||
|
|
||||
|
function safe_checkout_branch { |
||||
|
if test "$#" -ne 1 |
||||
|
then |
||||
|
echo >&2 "Použití: $0 <branch>" |
||||
|
return 1 |
||||
|
fi |
||||
|
|
||||
|
local BRANCH="$1" |
||||
|
local SCRIPT="$0" |
||||
|
|
||||
|
git fetch --all |
||||
|
local UPSTREAM_BRANCH |
||||
|
if git rev-parse "$BRANCH@{u}" >/dev/null 2>/dev/null |
||||
|
then |
||||
|
UPSTREAM_BRANCH="$BRANCH@{u}" # Stačí symbolicky. |
||||
|
else |
||||
|
# Tohle je jediná možná záchrana. |
||||
|
UPSTREAM_BRANCH="$UPSTREAM_REMOTE/$BRANCH" |
||||
|
fi |
||||
|
git rev-parse "$UPSTREAM_BRANCH" || die "Vzdálená větev $UPSTREAM_BRANCH neexistuje?" |
||||
|
|
||||
|
# Od teď si musíme dát pozor, abychom nezměnili kód, který právě běží. |
||||
|
# Zkontrolujeme, že se nemění tahle knihovna a skript, který běží. |
||||
|
# `git rev-parse` dává SHA-1 hashe objektů, vizte manuálovou stránku pro pochopení. |
||||
|
# Pozor: tohle porovnává jen verze commitnuté do gitu. Lokální změny udělají něco náhodného… |
||||
|
if test "$(git rev-parse @:make/lib.sh)" != "$(git rev-parse "$UPSTREAM_BRANCH":make/lib.sh)" |
||||
|
then |
||||
|
echo >&2 "Změna v make/lib.sh, prosím pullni manuálně" |
||||
|
exit 1 |
||||
|
fi |
||||
|
if test "$(git rev-parse @:"$SCRIPT")" != "$(git rev-parse "$UPSTREAM_BRANCH":"$SCRIPT")" |
||||
|
then |
||||
|
echo >&2 "Změna v $SCRIPT, prosím pullni manuálně" |
||||
|
exit 1 |
||||
|
fi |
||||
|
git checkout "$BRANCH" |
||||
|
git pull |
||||
|
git clean -f |
||||
|
} |
||||
|
|
||||
|
function install_everything { |
||||
|
# Skoro celé nasazení webu je stejné pro testweb i pro produkci, tak je to tady dohromady |
||||
|
gimli_only |
||||
|
ensure_venv |
||||
|
make/install |
||||
|
./manage.py migrate |
||||
|
./manage.py collectstatic --noinput |
||||
|
setfacl -R -m default:u:www-data:rX media static |
||||
|
setfacl -R -m u:www-data:rX media static |
||||
|
chown -R :mam . || true |
||||
|
chmod -R g+rX,go-w . || true |
||||
|
} |
||||
|
|
||||
@ -0,0 +1,14 @@ |
|||||
|
#!/bin/bash |
||||
|
|
||||
|
set -exuo pipefail |
||||
|
. make/lib.sh |
||||
|
|
||||
|
scp vue_frontend/webpack-stats.json "$GIMLI_LOGIN:$TESTWEB/vue_frontend/" |
||||
|
rsync -ave ssh seminar/static/seminar/vue "$GIMLI_LOGIN:$TESTWEB/seminar/static/seminar/" |
||||
|
ssh "$GIMLI_LOGIN" " |
||||
|
set -euxo pipefail |
||||
|
cd $TESTWEB |
||||
|
. make/lib.sh |
||||
|
ensure_venv |
||||
|
./manage.py collectstatic --noinput |
||||
|
" |
||||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue