final commit

Signed-off-by: Mohit Kumar <mkay6123@gmail.com>

Author: Mohitkumar6122

.gitignore

@@ -0,0 +1,5 @@
+.vscode
+.data
+node_modules
+dist/**/*
+

Dockerfile

@@ -0,0 +1,22 @@
+FROM node:carbon
+
+ENV NPM_CONFIG_LOGLEVEL info
+ENV NODE_ENV production
+
+ADD dist /home/node/app/dist
+ADD package.json /home/node/app/package.json
+
+ENV MONGODB_URI mongodb://db:27017
+ENV JWT_SECRET ashdfjhasdlkjfhalksdjhflak
+ENV SALT_SECRET 8
+
+RUN chown -R node:node /home/node/app 
+
+USER node
+WORKDIR /home/node/app
+RUN npm install --save
+
+EXPOSE 3000
+
+#CMD node dist/server.js
+CMD npm run watch

README.md

@@ -0,0 +1,120 @@
+
+# Node Rest API + JWT in TypeScript
+
+- This is a simple **Node Rest Api** written in **Typescript**.  
+- Routes can be protected with **JWT tokens**.
+- Authentification with Passport. 
+
+# How it works
+
+- The API dispatches requests with well structured **routes**.
+- Routes are using **controllers** for API implementations.
+- Controllers are using **models** for Mongo persistence.
+- Routes can be protected with **JWT authentification middelwares** :
+```typescript
+import { Router } from "express";
+import { ProductController } from "../controllers/productController";
+import { AuthController } from "../controllers/authController";
+
+
+export class ProductRoutes {
+
+    public router: Router;
+    public productController: ProductController = new ProductController();
+    public authController: AuthController = new AuthController();
+
+    constructor() {
+        this.router = Router();
+        this.routes();
+    }
+
+    routes() {
+        this.router.get("/", this.productController.getProducts);
+        this.router.get("/:id", this.productController.getProduct);
+        // The following routes are protected
+        this.router.post("/", this.authController.authenticateJWT, this.productController.createProduct);
+        this.router.put("/:id", this.authController.authenticateJWT, this.productController.updateProduct);
+        this.router.delete("/:id", this.authController.authenticateJWT, this.productController.deleteProduct);
+    }
+}
+```
+
+- Install dependencies
+```
+cd rest-api-node-jwt-typescript
+npm install
+npm run build
+```
+
+
+# Getting started
+
+
+## Step1 : Register a user
+Send a POST request to `http://localhost:3000/api/user/register` 
+with the following payload ** :
+```json
+{
+	"username": "me",
+	"password": "pass"
+}
+```
+You should get a JWT token in the response :
+```json
+{
+  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Im1lMiIsImlhdCI6MTU1MDU4MTA4NH0.WN5D-BFLypnuklvO3VFQ5ucDjBT68R2Yc-gj8AlkRAs"
+}
+```
+
+## Step2 : Create a Product
+Send a POST request to `http://localhost:3000/api/products` 
+with the following payload :
+```json
+{
+  "productId": "13",
+  "name": "Orange",
+  "price": 5,
+  "quantity": 6
+}
+``` 
+You should get an authorization **denied** !
+```json
+{
+  "status": "error",
+  "code": "unauthorized"
+}
+```
+Add the JWT token to the Authorization header :
+```http
+Content-Type: application/json
+Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Im1lMiIsImlhdCI6MTU1MDU4MTA4NH0.WN5D-BFLypnuklvO3VFQ5ucDjBT68R2Yc-gj8AlkRAs
+```
+You should have created the product !!
+```json
+{
+  "data": {
+    "_id": "5c6c0845e3eb8302ffd168c0",
+    "productId": "13",
+    "name": "Orange",
+    "price": 5,
+    "quantity": 6,
+    "__v": 0
+  }
+}
+```
+## Step2 : Get a Product
+You can get the product with or without token because the Get route of Product router is not protected with the JWT authentification middelware.
+Send a GET request to `http://localhost:3000/api/products/13`
+
+You should get :
+```json
+[
+  {
+    "_id": "5c6bfc97e3eb8302ffd168be",
+    "productId": "13",
+    "name": "Orange",
+    "price": 5,
+    "quantity": 6,
+    "__v": 0
+  }
+```

docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3"
+services:
+    db:
+      container_name: db
+      image: mongo
+      ports:
+       - "27017:27017"  
+      volumes:
+       - ./.data:/data/db
+    api:
+      container_name: api
+      build: .
+      ports :
+       - "3000:3000"
+      volumes:
+        - ./:/home/node/app