Skip to content

mskwara/MovieHubAPI

Repository files navigation

MovieHubAPI

Studenci: Adam Niemiec, Michał Skwara, Mikołaj Bul, Łukasz Stachoń,

Zarys projektu Głównym założeniem projektu jest stworzenie aplikacji opartej na bazie filmów i osób kina. Dodatkowymi możliwościami będą ocenianie, wystawianie recenzji oraz przeglądanie najnowszych wiadomości ze świata kinematografii. Każdy użytkownik aplikacji będzie mógł sprawdzać swoje indywidualne recenzje, komunikować się z innymi odbiorcami poprzez zostawianie komentarzy dotyczących konkretnych filmów oraz przeglądać aktualności dotyczące filmów/aktorów/nagród itp.

W projekcie planujemy wykorzystać technologie MongoDB oraz Node.js.

W celu przejrzenia dokumentacji projektu należy otworzyć plik dokumentacja.pdf

Instalacja:

  1. Otwórz konsolę i sprawdź wywołaj: node --version. Jeżeli zostanie wypisana wersja zainstalowanego node, nie musisz go instalować - przejdź do kroku 3.
  2. Zainstaluj node - https://nodejs.org/en/download/
  3. Otwórz folder projektu.
  4. W konsoli wywołaj: npm install
  5. Aby wygenerować dane wpisz w konsoli: npm run generate
  6. Następnie w konsoli wywołaj: npm start
  7. W tym momencie serwer łączy się z bazą danych i oczekuje na zapytania.

Używanie:

  1. Pobierz Postmana do wysyłania requestów - https://www.postman.com/downloads/

  2. Po lewej stronie w Postmanie naciśniej przycisk: Import

  3. W okienku wybierz plik requesty.json załączony w katalogu głównym projektu.

  4. Naciśnij przycisk Import.

  5. Aby zapamiętywanie bycia zalogowanym działało poprawnie musisz stworzyć Environment w Postmanie. Wybierz ikonkę oka po prawej stronie i naciśnij przycisk Add: obraz

  6. Wybierz jakąkolwiek nazwę dla środowiska oraz wyznacz zmienną o nazwie jwt: obraz

  7. Wybierz stworzone środowisko z rozwijanego panelu: obraz

  8. Po lewej stronie powinny być dostępne wszystkie requesty, które można teraz w prosty sposób wywołać.
    a) Niektóre z nich wymagają bycia zalogowanym - najpierw wyślij requesta umieszczonego w Users -> Login, podając w body
    username: test,
    password: test
    Dzięki temu jesteś teraz zalogowany na konto administratora. Można również wykorzystać request Users -> Signup do utworzenia własnego konta (zwykły użytkownik).
    b) Wybierz jeden z requestów
    c) W niektórych requestach metodą POST, PATCH występuje sekcja Body dostępna pod adresem requesta. Można tam zmienić przesyłane dane dotyczące danego requesta.
    d) Kliknij niebieski przycisk Send.

Interfejs Postmana: obraz

Aby uwzględnić bycie zalogowanym, w requeście ustaw następujące wartości (po zaimportowaniu naszego pliku requests.json nie powinno być takiej potrzeby): obraz

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •