/webclient

Temporary repository for project.

Primary LanguageTypeScript

Wprowadzanie zmian

  1. Sforkuj to repozytorium
  2. Skonfiguruj git'a aby podpisywał commity twoim imieniem, nazwiskiem i uczelnianym mailem
    1. git config --global user.name "FIRST_NAME LAST_NAME"
    2. git config --global user.email "sxxxx@pjwstk.edu.pl"
    3. Przydatna lektura nt. tego jak ludzie korzystają z git'a (https://git.wiki.kernel.org/index.php/CommitMessageConventions)
      1. Nie jest wymagane aby się stosować kropka w kropkę do reguł losowych przektów z tej strony, link bardziej jako inspiracja do wzorowania się
  3. Przejdź do swojego forka, skopiuj URL do klonowania i sklonuj repozytorium
  4. Prawdopodobnie będziesz potrzebować zrobić branch, np: git checkout -b #ticket_id_name
  5. Przed każdym commitem pamiętaj aby sprawdzić czy projekt dalej poprawnie się buduje
  6. Jeśli ktoś oprócz ciebie pracował nad kodem, dodaj go jako co-author https://stackoverflow.com/questions/7442112/how-to-attribute-a-single-commit-to-multiple-developers
  7. Po wprowadzeniu kilku lub jednego commita zrób git push
  8. Jeśli praca nad daną funkcją jest skończona to należy teraz zrobić pull request (wejdź na URL oryginalnego repozytorium i przejdź do zakładki pull requests, w UI jest wszystko opisane)
  9. Ktoś zaakceptuje i zmerguje te zmiany kiedyś

Uruchamianie (wymagany zainstalowany NodeJs)

  1. Sklonuj to repozytorium
  2. Wykonaj npm i, aby zainstalować zależności
  3. Wykonaj npm start, aby uruchomić aplikację
  4. Aplikacja powinna być dostępna na localhost pod portem 3000

Dodatkowe uwagi do testowania/uruchamiania. WAŻNE!

  • Jeśli znajdujesz się poza uczelnią, musisz podłączyć się do VPN, żeby aplikacja działała poprawnie
  • Aplikację należy uruchomić/testować w przeglądarce z wyłączonym CORS Policy (w każdej przeglądarce robi się to trochę inaczej, ale można to sobie łatwo wyszukać w internecie)

Wszelkie problemy i błędy, które zostaną zgłoszone przy niespełnieniu powyższych wymagań będą ignorowane!