Skip to content

Marucik/Ulatwiaczek

Repository files navigation

Ułatwiaczek
Bo ułatwia / jasne jak słońce! [ ͡° ͜ʖ ͡°]

Ułatwiaczek w internecie: ulatwiaczek.herokuapp.com

Uruchamianie aplikacji na komputerze lokalnym:

Żeby uruchomić Ułatwiaczka lokalnie, musimy wykonać następujące kroki:

  1. Pobieranie potrzebnych materiałów:

    1. Klonujemy branch master z repozytorium;
    2. Pobieramy Python'a w wersji 3.6.0 dla naszego systemu;
    3. Pobieramy Node.js w wersji 7.5.0;
  2. Sprawdzenie poprawosci instalacji Python'a oraz Node.js:

    1. Otwieramy konsolę i wpisujemy python --version. Powinniśmy ujrzeć:

      wersja Python'a
    2. Otwieramy konsolę i wpisujemy node --version. Powinniśmy ujrzeć:

      wersja Node.js
  3. Przygotowanie wirtualnego środowiska:

    1. Przechodzimy w konsoli do głównego folderu projektu (można go poznać po plikach manage.py, requirements.txt, README.md;

    System plików

    1. Wpisujemy komendę pip install virtualenv.
      Po zakończeniu instalacji sprawdzamy czy wszystko zainstalowało się poprawnie komendą virtualenv --version;
      Wersja virtualenv

    2. Tworzymy wirtualne środowisko virtualenv virtualenv i aktywujemy go:
      W przypadku Linuxa: source virtualenv/bin/activate
      W przypadku Windowsa: virtualenv\Scripts\activate

    3. Po wykonaniu tej komendy nasza konsola powinna wyglądać następująco:
      Wejscie do virtualenv

      Należy pamiętać, że musimy wejść do naszego wirtualnego środowiska za każdym razem jeżeli chcemy uruchomić naszą aplikację lokalnie ( ͡^ ͜ʖ ͡^).

    4. Następnie instalujemy Python'ową paczkę, która zawiera między innymi Django, na którym oparty jest nasz projekt.
      Paczkę instalujemy poleceniem pip install -r requirements.txt. Po skończeniu pobierania sprawdzamy czy Django zainstalował się poprawnie poleceniem python -m django --version

      Sprawdzanie wersji Django

    5. Teraz instalujemy Gulp'a i potrzebne do jego działania moduły.
      Będąc w głównym folderze projektu wpisujemy w konsolę: npm install. NodePackageManager automatycznie zainstaluje za nas potrzebne moduły które są zawarde w pliku package.json.

    6. Po instalacji modułów npm w konsolę wpisujemy komendę: gulp css:compile.
      Powinniśmy ujrzeć taki widok:

      Kompilowanie plików scss

    7. W pliku ulatwiaczek/setting.py zmienną DEBUG zmieniamy na True

  4. Uruchomienie serwera i dodawanie danych:
    Po wykonaniu poprzednich kroków, wreszcie możemy uruchomić naszą aplikację na lokalnym serwerze! Żeby to zrobić, wykonujemy następujące kroki:

    1. W konsoli [w której mamy uruchomione wirtualne środowisko!] otwartej w głównym folderze projektu (poznamy go po pliku manage.py) wpisujemy komendę: python manage.py runserver
      Powinniśmy zobaczyć coś takiego:
      Uruchomiony serwer
    2. Uruchamiamy przeglądarkę i wpisujemy adres: 127.0.0.1:8000. Powinna nam się pokazać strona Ułatwiaczka.