iT邦幫忙

2022 iThome 鐵人賽

DAY 26
0
自我挑戰組

web 應用開發筆記系列 第 26

[Day 26] Note - NPM Start

  • 分享至 

  • xImage
  •  

在這個章節會使用到 NPM 來建置你的 Node 專案,初始化專案的同時也會介紹一些相關的套件協助你撰寫專案。

What is NPM

NPM (Nodejs Program Management) 是 NodeJS 平台的套件管理工具,你可以使用它來管理所安裝的套件,可以在這裡找到其他開發者所撰寫的套件,你也可以寫一個發布在上面供大家使用,下一步將介紹如何使用它開始一個專案

NPM Init

  1. 在你的終端機上前往你想建立專案的資料夾中,輸入 npm init 來初始專案
  2. 輸入初始資訊
    • Package-name - 專案名稱
    • Version - 專案版本號 (1.0.0)
    • Description - 專案的說明
    • entry point - 起始程式的名稱(預設是 index.js)
    • test command - 測試用的指令,可留白
    • git repository - git 倉儲的位址,有 remote 會自動生成,沒有的話可留白但會有警告
    • Keyword - 專案的關鍵字,可自訂亦可留白
    • Author - 作者名稱,請寫下你自己的大名
    • Licence - 授權,可註明授權種類,預設為( ISC )
  3. 輸入完後自動產生 package.json,此文件為你的專案進入點,任何設定及套件管理都會寫在這裡
  4. 現在你有一個專案的描述檔了,以下為範例

EX:

{
  "name": "foodstry-backend",
  "version": "1.0.0",
  "description": "The backend of foodstry which is the food management tool.",
  "main": "app.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/ci-yang/foodstry-backend.git"
  },
  "author": "Ci Yang",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/ci-yang/foodstry-backend/issues"
  },
  "homepage": "https://github.com/ci-yang/foodstry-backend#readme"
}

scripts 可撰寫各種指令,除了預設的 start & test 可以直接使用 npm [command] (e.g. npm start) 以外,其餘自訂的指令必須使用 run npm [command] (e.g. run npm lint)

NPM install

使用 install 安裝你的套件

指令

npm install [package name]

注意事項:

  • 會在 local 產生一個 node_modules 資料夾,存放所有安裝的套件
  • 後綴加上 -g 可以在全域的環境中安裝該套件
  • 版本號有以下規則(詳細見圖)
    • "^" - caret: 小版本號與 patch 版本可更動
    • "~" - tiled: patch 版本可更動
  • 需要解安裝使用 uninstall

套件

以下介紹利於開發的各項套件,我們也將在之後的張皆使用他們開發我們的專案

  1. chalk
  2. debug
  3. morgan
  4. nodemon
  5. eslint

上一篇
[Day 25] Take a break~ Transform360 buuild in windows (下)
下一篇
[Day 27] Building Landing Page Environment
系列文
web 應用開發筆記30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言