Vegapo

Vegapo mapuje vegánske potraviny a produkty na Slovenskom a Českom trhu.

Poznámka

Toto je technická dokumentácia pre developerov. Nasledujúci text predpokladá ovládanie základov programovania a vývoja webových aplikácií. Ak hľadáte informácie pre bežného užívateľa, čoskoro budú dostupné na web stránke.

Technické požiadavky

Vyvojové prostredie

PHP 7.0 +
MySQL 5.6 +
Apache 2.4 +
Moderný Internetový Prehliadač

Ďalšie požiadavky

Composer
Bower
Virtuálna doména (veg.dev.sk a veg.dev.cz)

Použité knižnice a frameworky

Backend cez Composer

https://github.com/Matoo125/Vegapo/blob/master/composer.json

M4MVC 0.3 + (Framework)
Twig 2.0 (Template engine pre views)
Parsedown 1.6+ (Prelklad z Markdown formátu do html, použité pri footer info stránkach)
PHP Mailer 5.2 + (Posielanie emailov pri obnove hesla a odpovedanie na správy ľudí cez kontakt)
Image Intervention 2.3 + (Vytváranie thumbnailov a manipulácia obrázkov)
Whops 2.1 + (Správa error a exception počas vývoja)
SDiff 1.0 + (Zvýraznenie zmien pri logovaní)

Front End cez bower

https://github.com/Matoo125/Vegapo/blob/master/bower.json

Botstrap 4 (Hlavný framework)
Animate.css 5.3.2 + (Css animácie)
Ionicons 2 + (ikony)
jQueryValidation 1.16 + (validácia formulárov)
bLazy 1.8 + (Lenivé / Postupné načitavanie obrázkov)
Fancybox 3.0.47 + (Zväčšivanie obrázkov po kliknutí)
Quaga 0.11.6 + (Načítanie čiarového kódu z obrázku)
SimpleMDE 1.12. + (MarkDown Editor pre foter info stránky)

Inštalácia

V prvom rade je treba mať nainštalovaný *AMP server (na windowse odporúčam použiť Laragon), composer a bower (node, npm, git).

// vývojové prostredie pripravené

Potom si môžeme naklonovať repozitár

git clone https://github.com/Matoo125/Vegapo.git

Otvoríme zložku

cd Vegapo

Nainštalujeme composer knižnice

composer install

Nainštalujeme Bower knižnice

bower instal

Vytvoríme virtuálnu doménu (v závyslosti od operačného systému si treba vygogliť ako)

// google search: How to create virtual host (XAMP / LAMP / WAMP / MAMP / Laragon)
// vegapo.dev.sk
// vegapo.dev.cz

Nainštalujeme databázu z __instal zložky

// Databáza bola úspešne vytvorená

Premenujeme app/core/config.example.php na config.php

mv app/core/config.example.php app/core/config.php

Vložíme prihlasovacie údaje k databáze do config súboru

define("DB_HOST", "localhost");
define("DB_NAME", 'vegapo');
define("DB_USER", "phpmyadmin");
define("DB_PASSWORD", "123456");
define("SHOW_ERRORS", true);

Css súbor je potrebné stiahnuť alebo exportovať z css/public/styles.sass do css/public/styles.css

Hotovo, aplikácia je nainštalovaná. Obrázky k demo databáze sa dajú stiahnuť na tomto odkaze, avatary

Ako sa zapojiť

Ako prvé je najlepšie si prezrieť issues a prípadne založiť nový. Po vytvorení zmien v kóde, prosím pošlite pull request.

Vývojová konvencia

Viem, že zatiaľ to tak nieje všade ale bolo by dobré písať kód s 4 alebo 2 medzerami namiesto tabu (je možné si to nastaviť v editore) a taktiež aj preformátovať súbor na ktorom zrovna robíťe zmeny ak sú v ňom klasické taby.

Zo začiatku som používal slovenské slová, ako názvy tried a metód, bolo by však dobré písať v angličtine.

Podpora

Ak máte problém s inštaláciou alebo ste našli nejaký bug, či máte návrh na vylepšenie alebo zmenu, prosím otvorte nový “isue” tu na Githube, alebo nás kontaktujte cez formulár na web stránke.

Licencia

GNU General Public License v3.0

Matoo125 / Vegapo

readme