manifest/README.md

85 lines
2.1 KiB
Markdown

# Jugofuturisticni manifest
Spletna platforma za skupno pisanje Jugofuturisticnega manifesta.
## Specifikacija
Je na voljo tukaj:
https://pisi.kompot.si/p/yufu-specs
## Postavitev razvojnega okolja
Najprej namestimo [ddev](https://ddev.com/get-started/).
Nato vzpostavimo / poženemo zabojnike z ukazom `ddev start`.
Namestimo odvisne PHP pakete z ukazom `ddev composer install`.
Osnovne podatke pa vnesemo z ukazuma:
`ddev drush site:install --account-name=root --account-pass=toor --existing-config minimal`
Sajt je dostopen preko naslova: https://yufu-manifest.ddev.site/
Lahko pa napišemo tudi `ddev launch`
v `web/sites/default/settings.local.php` dodamo vrstico, ki vključi services nastavitve, ki omogočijo CORS:
`$settings['container_yamls'][] = DRUPAL_ROOT . '/sites/default/yufu.services.yml';`
### Postavitev (vuejs) "prednjegadela"
Najprej gremo v podfolder `nuxt` in namestimo odvisne javascript pakete:
`cd nuxt`
`npm i`
Skopiramo privzete nastavitve v dejavne:
`cp .env.dist .env`
Po potrebi vsebino `.env` prilagodimo.
Nato poženemo izgrajevalnik / strežnik:
`npm run dev`
### Uvoz testne vsebine
`./skripte/uvozi-vsebino.sh`
Dodatne testne vsebine lahko definiramo v modulu `yufu_data`, v poddirektoriju `content`. Pazit moramo na ime - vsak fajl se mora končati s `.content.yml`.
Navodila za konstruiranje fajlov pa so tukaj: https://www.drupal.org/docs/contributed-modules/yaml-content/examples
# Dokumentacija
## Backend
### Endpoint za dodajanje pojmov
V modulu [yufu_concept](web/modules/custom/yufu_concept/yufu_concept.info.yml "yufu_concept").
### Obveščanje prek mailov
1. Ko je dodan nov pojem ali posodobljen star pojem, obvesti o tem vse urednike.
- ob novi draft revizija se poslje mail urednikom
2. Ko je sprejet nov pojem ali revizija, obvesti uporabnika in ga odblokiraj.
- ob novi publishani revizijami se poslje mail uporabniku, ki jo je naredil.
Funkcionalnost se nahaja v yufu_admin modulu.
# Debugging
Razvojne kontejnerja lahko zlistamo z ukazom `ddev status`
## Mejli
Mailhog za debagiranje vklopimo, kot priporoči zgornji ukaz: `ddev launch -m`
Vmesnik najdemo na naslovu: https://yufu-manifest.ddev.site:8026