ChienKangLu / typescript_template

template for nodejs project with typescript and RESTful Service

TypeScript Template

• Install Node.js
• Install local package
• Install/uninstall/link/list global package
• Create project
• RESTful API
• Reference

Install Node.js

1. Install node.js https://nodejs.org/en/

Install local package

1. Install and add to dependencies

   npm install --save

2. Save the module as a development dependency (Instead of global modules)

   npm install --save-dev

3. Install for typescript module locally

   npm install --save @types/mathjs

Install/uninstall/link/list global package

1. list global package

   npm list -g --depth 0

2. Instal global

   npm install -g package-name

3. Remove global

   npm uninstall -g package-name

4. Use global modules locally (Not Recommanded, Global modules don't be listed as dependencies, even though the project depends on them.)

   npm link package-name

Create project

1. Create folder

2. Create package.json

   npm ini

3. Install for module locally (typescript,express,body-parser,express-session)

   npm install --save-dev typescript

   npm install --save express

   npm install --save body-parser

   npm install --save express-session

4. Install types of module locally

   npm install --save-dev @types/typescript

   npm install --save @types/express

   npm install --save @types/body-parser

   npm install --save @types/express-session

5. Add tsc Path

   D:\data\NodejsProjects\typescript_template\node_modules

6. Create tsconfig.json

   tsc –init

7. Configure tsconfig.json and compile by tsc

   1. Configure tsconfig.json

      ...
      "target": "es6",
      "outDir": "dist",
      "rootDir": "src",
      "strict": false
      ...
      "include": ["src"],
      "exclude": []

   2. Create src folder and delete.ts in src
   3. Compile .ts into .js

      tsc

   4. Remove delete.ts and dist

RESTful API

Representational State Transfer (REST) is a software architectural style. Web services that conform to the REST architectural style is termed RESTful Web services (RWS).

REST designed Web services whose operations match to particular HTTP methods.

• Operation -> HTTP method
• CREATE -> POST
• READ -> GET
• UPDATE -> PATCH
• DELETE -> DELETE

HTTP Status Codes

• 201 Created
• 404 Not Found
• 200 OK
• 204 No Content

Reference

• Nodejs Complete Tutorial
• Why don't use global modules?
• RESTful API Tutorial
• What's RESTful?
• HTTP Status Codes
• WIKIPEDIA-REST