Skip to content

bipin3002/JedlikTsTemplate

 
 

Repository files navigation

VS Code + TypeScript + Node.js + GitHub + Heroku

Heroku teszt:

https://jedlik-ts-template.herokuapp.com/ (Deploy menete: Deploy_on_Heroku.pdf)

A. Fejlesztői környezet telepítése, beállítása

  1. Node.js letöltése, telepítése:
    https://nodejs.org/en/download/
  2. Git for windows telepítése
    https://git-for-windows.github.io/
  3. Visual Studio Code - User Installer (továbbiakban VSCode) telepítése
    https://code.visualstudio.com/Download
  4. VSCode futtatása, Visual Studio Extensions telepítése: Ctrl-Shift-X
    Kiterjesztés keresése, telepítés:
    • "Add jsdoc comments" (opcionális)
    • "Debugger for Chrome" (fontos, kell)
    • "GitLens" (extra Git funkciók, opcionális a telepítése)
    • "Markdown All in One" (opcionális)
    • "TypeScript TSLint Plugin" (NEM a "TSLint (deprecated)" !!! ) (fontos, kell)
    • "Spell Right" (helyesírás ellenőrzés) (opcionális)
    • további kiterjesztések telepítése igény szerint
  5. Billentyűkombinációk beállítása:
    File\Preferences\Keyboard Shortcuts menüvel, vagy Ctrl-K majd Ctrl-S
    Parancs keresése: gépeléssel
    Hozzárendelés, módosítás: "ceruza" ikonra kattintással, törlés: Del bill.
    • gépel: "reopen" > parancs: "Reopen Closed Editor" > Remove Keybindings (vagy Del bill.)
    • gépel: "test" > parancs: "Run Test Task" > hozzárendel: Ctrl-Shift-T
    • gépel: "delete" > parancs: "Delete Line" > hozzárendel: Ctrl-L
    • opcionális: további billentyűkombinációk hozzárendelése tetszés szerint
  6. A .vscode/settings.json állományban ("files.exclude" szekcióban) vezérelhető az
    Explorer ablakban megjelenő állományok/mappák láthatósága
  7. Opcionális: VSCode beállítása: lsd. az oldal végén

B. Projekt előkészítése (inicializálása)

  1. https://github.com/nitslaszlo/JedlikTsTemplate.git
    • Ha nem akarsz klónozni:
      JedlikTsTemplate-master.zip letöltése, kicsomagolása a projekt szülőmappájába
      Vagy:
    • Repo klónozása
      Parancssor -> cd a projekt szülőmappája
      "git clone https://github.com/nitslaszlo/JedlikTsTemplate.git"
      Ha nem vagy társ-fejlesztő (contributor), akkor töröljed a .git mappát!
  2. JedlikTsTemplate mappa átnevezése tetszőlegesen, ha új projektet készítünk
    Klónozott vagy átnevezett mappa helyi menüből: Open with Code,
    vagy a VSCode indítása után File/Open Folder... menüpontba a project mappa megnyitása
  3. VSCode terminál ablak aktiválása: View/Integrated Terminal menüvel, vagy Ctrl-ö
    Node.js lokális modul(ok) telepítése:
    terminál ablakból "npm i" parancs futtatása (@types/node modult telepíti, lsd.: package.json)

C. Fejlesztés, tesztelés, kilépés, KILL

  1. VSCode indítása (utoljára megnyitott projektet visszatölti), vagy
    Project mappa helyi menüből: Open with Code, vagy
    VSCode indítása után File/Open Folder... menü pontba a project mappa megnyitása
  2. Ctrl-Shift-B => TypeScript forrás átalakítása JavaScript-re
    (app.ts => app.js, "npm run compile" parancsot futtatja)
    (watch üzemmód, az első fordítás után már automatikus a fordítás)
    (amig aktív a task, addig nem kell (lehet) újraindítani)
  3. Ctrl-Shift-T => nodemon indítása
    ("npm run start" parancsot futtatja)
    (amig aktív a task, addig nem kell (lehet) újraindítani)
    (FONTOS!!! Olvasd el a 6. pontot!)
  4. content.ts szerkesztése
  5. Futtatás: Chrome: http://localhost:8080/
    A nodemon változás esetén csak a webszervert indítja újra, a böngészőt F5-el (böngészőben) kell frissíteni!
    Nyomkövetés (beépített debugger és Chrome összekapcsolása):
    VS Code-ban F5 -el (elhelyezett töréspontoknál megáll, változók vizsgálata)
  6. Kilépésnél a Ctrl-Shift-T-vel indított nodemon szerver tovább fut!
    Javasolt a terminál ablakban egy Ctrl-C-vel megszakítani a futását!
    Ha ezt elfelejted, és nem indul (hibát jelez) újraindítás után a nodemon, akkor
    futtasd az "npm run kill" parancsot a terminál ablakból.

D. Verziók és telepített node.js csomagok lekérdezése terminálablakból:

  • TypeScript: tsc -v
  • Node.js: node -v
  • git: git --version
  • npm: npm -v
  • telepített globális csomagok: npm -g ls --depth=0
  • telepített lokális csomagok: npm ls --depth=0

E. Komponensek frissítése

  • VSCode: Automatikus, balra lent a fogaskeréken jelzi, ha új verzió jön ki
  • VSCode kiterjesztések: Automatikus, balra az Extensions ikon jelzi, ha új verzió jön ki
  • TypeScript: npm update -g typescript
  • Node.js: npm install --save-dev @types/node

F. Hasznos linkek:

G. Verziókezelés Git-el VS Code-ban (nagyon alap, opcionális):

  1. GitHub account létrehozása:
    https://github.com/
    (nitslaszlo az account név a példában)
  2. Git repository létrehozása:
    pl.: GitHub asztali alkalmazással vagy github.com-on
    (JedlikTsTemplate a repository neve a példában)
  3. Git konfigurálása CMD vagy "Git CMD" ablakból:
    • git config --global user.name nitslaszlo
    • git config --global user.email [email protected]
    • git config --global credential.helper wincred
  4. Visual Studio Code indítása - project betöltése
  5. Ha van klónozott projektben .Git (rejtett!!!) mappa, akkor törölni kell
  6. Git inicializálása a 3. ("Y") ikonnal vagy Ctrl-Shift-G
    majd "Initialize Repository"-ra kattint (felül a rombusz ikonnal)
    majd meg kell adni a projekt könyvtárát a git-nek
  7. Remote repository megadása új terminál ablakból (Ctrl-Shift-ö), például:
  8. ".gitignore" fájl szerkesztése/létrehozása (ezek a mappák/állományok nem lesznek feltöltve):
    Ctrl-N -el új fájl létrehozása vagy meglévő szerkesztése
    A fájl tartalma:
    node_modules
    npm-debug.log
    (További mappák és fájlok megadhatók, melyek nem kerülnek "feltöltésre")
    Ctrl-S -> .gitignore néven menteni a projekt főkönyvtárába
  9. Ctrl-Shift-G -> Commit message megadása felül, majd "commit" utasítás kiadása
    Ctrl-Enter -el, vagy felül a "pipa" ikonnal
  10. "There are no staged ..." kérdésre válaszolj "always"-el
  11. Változások szinkronizálása ("feltöltés")
    Alul a státus sorban balra "Synchronize Changes" ikonra kattint
    Első alkalommal a GitHub felhasználói nevet vagy e-mail címet és jelszót kér!
  12. Változások szinkronizálása ("feltöltés")
    Alul a státus sorban balra "Synchronize Changes" (felhő) ikonra kattint
    Később fel- és letöltésnél egymást "kergető" nyilak lesznek.
  13. A "Would you like Code to periodically run 'git fetch'?" kérdésére válaszoljunk "yes"-el
    ("git.autofetch": true lesz beállítva, alapértelmezésben 3 percenként ellenőrzi a változásokat)

H. VS Code editor beállítása:

  1. Ctrl-Shift-P vagy F1
  2. "Preferen..." gépelése
  3. Preferences: "Open Workplace Settings" a projektben tárolt beállításokhoz (ez az erősebb) vagy
    Preferences: "Open User Settings" a felhasználónál tárolt beállításokhoz
    Konfig fájl workspace: projekt/.vscode/settings.json
    Konfig fájl user: c:/Users/UserName/AppData/Roaming/Code/User/settings.json

About

VS Code + TypeScript + Node.js + Heroku template Teszt: https://jedlik-ts-template.herokuapp.com/

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 100.0%