Učební Kartičky

Webová aplikace Učební Kartičky, která vznikla v rámci projektu na VUT FIT v roce 2022.

Autoři

David Chocholatý (xchoch09@stud.fit.vutbr.cz)

Tomáš Bártů (xbartu11@stud.fit.vutbr.cz)

Šimon Vacek (xvacek10@stud.fit.vutbr.cz)

URL aplikace

https://ucebnikarticky.jednoduse.cz/

Uživatelé systému pro testování

Existující zástupci všech rolí uživatelů (pozn.: tito zástupci jsou již vytvořeni ve veřejné verzi na https://ucebnikarticky.jednoduse.cz/).

Login	Heslo	Role
admin@example.com	admin	Administrátor
BBELM@example.com	Osciloskop123	Učitel
speedy@example.com	BigShock	Student
bez loginu	bez hesla	Nepřihlášený uživatel

Instalace

Celý projekt si lze stáhnout z následujícího odkazu:

https://github.com/davidchocholaty/ucebni-karticky/tree/2ba95bd2c88bbe3be16cdca895692f07416b9086

Požadavky

Pro spuštění projektu je zapotřebí splnit následující požadavky:

• PHP: ^7.3
• Laravel: ^8.75 (pozn.: bude nainstalováno automaticky při následující instalaci projektu, viz dále)
• Composer: otestováno na 2.4.2 - 2.4.4
• Databáze: MySQL (InnoDB)
• Požadavky na verze knihoven (viz soubor composer.json):

  - pozn.: bude nainstalováno automaticky při následující instalaci projektu, viz dále

  • Požadovány:
    • fruitcake/laravel-cors: ^2.0
    • guzzlehttp/guzzle: ^7.0.1
    • laravel/framework: ^8.75
    • laravel/sanctum: ^2.11
    • laravel/tinker: ^2.5
    • laravel/ui: ^3.4
    • ext-json: *
  • Požadovány pro vývoj:
    • facade/ignition: ^2.5
    • fakerphp/faker: ^1.9.1
    • laravel/sail: ^1.0.1
    • mockery/mockery: ^1.4.4
    • nunomaduro/collision: ^5.10
    • phpunit/phpunit: ^9.5.10

Pro instalaci PHP například verze 7.4 na Ubuntu 20.04 lze doporučit postup dle následujícího odkazu:

https://www.digitalocean.com/community/tutorials/how-to-install-php-7-4-and-set-up-a-local-development-environment-on-ubuntu-20-04

Pro instalaci Composer na Ubuntu 20.04 lze doporučit postup dle následujícího odkazu:

https://www.digitalocean.com/community/tutorials/how-to-install-composer-on-ubuntu-20-04-quickstart

Postup instalace a spuštění

Po nainstalování všech požadovaných utilit (PHP a Composer) postupujte dle následujících instrukcí:

1. Nejprve je nutné si stáhnou celý projekt z výše uvedeného odkazu (github). Po stažení a případném rozbalení archivu se přesuňte do kořenové složky projektu příkazem:

   $ cd ucebni-karticky/

   Všechny další úkony provádějte výhradně ve zmíněné umístnění. Poté pro instalaci zadejte následující 2 příkazy:

   $ composer update 
   $ composer install

2. Dále je nutné vytvořit soubor .env a jeho obsah vyplnit obsahem souboru .env.example. Zmíněný postup lze provést následujícím příkazem:

   $ cp .env.example .env

3. Poté je třeba vytvořit vlastní MySQL databázi. Po jejím vytvoření je nutné její název, uživatele a jeho heslo zadat do souboru .env za následující parametry ve stejném pořadí:

    
   • DB_DATABASE=jméno databáze
   • DB_USERNAME=jméno uživatele
   • DB_PASSWORD=heslo uživatele
    

4. Jako další krok zadejte uvedený příkaz pro vygenerování klíče:

   $ php artisan key:generate

5. Jako předposlední krok bude vytvořena struktura databáze a naplněna testovacími daty. Pro vygenerování uvedených uživatelů systému společně s náhodně vygenerovanými uživateli zadejte následují příkaz:

   $ php artisan migrate:fresh --seed

   Pozn.: pro vytvoření databáze bez naplnění testovacími daty zadejte příkaz:

   $ php artisan migrate:fresh.

   Poté je možná naplnit vytvořenou strukturu tabulek pomocí přiloženého SQL skriptu input.sql. Případně je možné totožný skript najít ve složce /docs ve staženém projektu.

6. Po splnění všech požadavků je pak možné projekt spustit následujícím příkazem při umístění v kořenové složce projektu:

   $ php artisan serve

   Po zadání uvedeného příkazu pak lze na webovou stránku přistoupit na adrese uvedené ve výstupu terminálu:

   například: 127.0.0.1:8000

   Pro testování aplikace je opět možné využít výše zmíněné uživatele systému pro testování tak, jako je tomu v případě veřejné verze na https://ucebnikarticky.jednoduse.cz/.

---

Pozn.: pro spuštění poskutnutých testů zadejte následující příkaz:

$ php artisan test