Fáze 0: Docker, Git a základní nasazení

Ještě než začnete programovat, je vhodné si ověřit, že jste schopni nahrát jednoduchou webovou aplikaci do našeho testovacího prostředí. V této fázi vám ukážeme, jak na to. Pokud některému kroku nerozumíte, nezoufejte! Samotný vývoj aplikace bude mnohem přímočařejší a nevyžaduje hlubší pochopení následujících kroků.

Git

Git je verzovací systém používaný všemi vývojáři na světě a umožňuje různým lidem na různých zařízeních spolupracovat na jednom projektu bez nutnosti posílat si zdrojový kód poštovními holuby^[?]. Pokud jste se s gitem nikdy nesetkali, doporučujeme se podívat na oficiální Quickstart guide od GitHubu, což je platforma kterou budete během soutěže využívat.

Nejdříve vytvořte GitHub repozitář s názvem ve tvaru TdA26-NazevTymu. Pokud název vašeho týmu obsahuje znaky, které nemohou být ve jménu repozitáře tak to nevadí, důležité je, aby bylo poznat, že repozitář patří vašemu týmu. Doporučujeme repozitář nastavit jako soukromý a pozvat do něj pouze členy týmu.

Při vytváření repozitáře můžete využít námi připravené šablony. Je k dispozici několik šablon pro nejčastěji využívané technologie a jazyky, a pokud chcete použít technologie pro kterou šablona není, tak si zvolte generickou šablonu, která obsahuje pouze GitHub Akci (to, co vám umožní aplikaci nahrát do testovacího prostředí).

Nyní přidejte do repozitáře náš účet Tour-de-App-user.

Abyste jen nečinně nečekali na přijetí pozvánky, nastavte si mezitím klíč k odevzdávání.

• Přihlašte se do našeho odevzdávacího systému Tour de Cloud a nechte si vygenerovat token.
• V nastavení repozitáře (Settings) běžte do záložky Secrets and variables ⇒ Actions a vytvořte nový repository secret s názvem TEAM_TOKEN a jako hodnotu nastavte daný token.

Jednoduchá aplikace

Protože v této fázi jen testujeme, zda dokážete nasadit a spustit aplikaci, budou potřeba jen dvě věci:

• Na indexové stránce, která se nachází na / musí být HTML stránka, která kdekoliv obsahuje text “Hello TdA”

• K dispozici také musí být první API^[?] na adrese https://<identificator>.tourde.app/api, které bude na GET request vracet následující JSON^[?] objekt:

{ "organization": "Student Cyber Games" }

TIP: Pokud aplikace bude zobrazovat text “Hello TdA” jako canvas, tak nebude možné aby prošla naším automatickým testem.

Docker

Protože existuje velké množství různě nakonfigurovaných prostředí, bylo by prakticky nemožné zajistit, aby všem vývojářům aplikace fungovala na jejich počítači stejně jako na serveru. Z toho důvodu používáme technologii Docker, která umožňuje aplikace spouštět ve stejném virtuálním prostředí za pomocí kontejnerizace^[?] .

Pokud jste se s dockerem nikdy nesetkali, připravili jsme si pro vás návod, který vás provede základním nastavením Dockeru.

Pokud jste využili námi připravené šablony mimo generické, není v nich potřeba žádné změny dělat. Jestliže jste si vybrali generickou šablonu, implementace samotné kontejnerizace vaší aplikace (napsání Dockerfile a Docker-Compose) bude zcela na vás.

Odevzdání a spuštění testů

Teď, když máte vše nakonfigurované a vaše aplikace obsahuje vše, co má, je čas aplikaci nahrát k nám a spustit testy. GitHub akce, kterou jsme pro vás připravili, je nastavená tak, že se spustí při každém commitu do main větve vašeho repozitáře.

Pro větší kontrolu nad tím, jaká verze aplikace je u nás nahraná, můžete udělat několik věcí:

• Náš odevzdávací systém uchovává posledních 5 verzí vaší aplikace, ze kterých si můžete vybrat tu, kterou chcete nasadit.
• Na GitHubu vypnout akci a zapínat ji pouze jste-li si jisti, že chcete nahrát novou verzi.
• Modifikovat konfigurační soubor GitHub akce, jak vám to vyhovuje.
• Vytvořit si vývojovou větev a do hlavní ji mergovat pouze když potřebujete.

Jakmile vidíte, že GitHub akce proběhla úspěšně, zamiřte na Tour de Cloud a klikněte na tlačítko „Spustit testy“ u nulté fáze. Pokud testy dopadnou úspěšně, gratulujeme – můžete se pustit do dalšího vývoje aplikace.