skrmain / todo-api

Hi there 👋

todo-api's Issues

Use ESM - NodeJS

• https://nodejs.org/api/esm.html
• https://formidable.com/blog/2021/node-esm-and-exports/

Fix Swagger Documentation

• Update to user v3
• https://swagger.io/docs/specification/about/
• Setup Authentication Method
• Update/Add Response Codes

Merge `ExpressJS-FileHandling`

Add Email Functionality - Using own mail server

• merge https://github.com/skrstore/ExpressJS-Email-Verification

Add sorting, pagination, filtering, searching - where possible

• products route
• orders route
• saved products routes

Update APIs response Structure

Example Success Response

• URL: GET:/users?pageSize=10&pageNumber=1

{
  "metadata": {
    "totalCount": 100,
    "pageSize": 10,
    "pageNumber": 1,
    "sortBy": "name",
    "sortOrder": "asc"
  },
  "status": true,
  "message": "Success",
  "data": [{}, {}]
}

Add `winston` for logging, Setup proper logging

• Explore DEBUG variable usage

Store userId in product model

Check for automatic Release Notes Generation

save Product (add limit of 100) products can be saved

Release v0.2

• Add morgan
• Push image to Docker Hub
• Check for change log auto generate using Issues Done

Publish docker image on DockerHub

Check for DB Migrations(mongoose migrations)

Update User Entity

Add Following Fields

• Name

Brainstorm

Setup GitHub Actions for Building and Pushing to DockerHub

Add information with todo about with how many it is shared

Payment Integration - Phase - 1

Product is getting saved with invalid(productId) [Product that does not exists]

Add product exists check before following for Save Product List

• save
• [ ] remove

Fix the total of Order Model

Current

• Storing the total of Each Product Separately

Expected

• Should store the total of complete order

Todo

• Move the field from ProductInfo Model to Order Model
• Fix the Logic while placing the order /checkout

Use Async Wrapper

• Or Explore how express-async-errors works

Setup Proper Error Throwing

• Setup Error Classes
• Add Proper and consistent Error Code and message in response

API Docs

• REF: https://github.com/aperkaz/express-open-api
• Also Check for Using Making Postman Collection Public

Store Price of Product at time of placing the order

• Update the Model ProductInfo Model name to OrderProductInfo
• Add new Field (price) in Model
• All logic in '/checkout' to store price
• Also, Update the ProductInfo Model name to CartProductInfo in cart app

Update Eslint Configurations

• Both VSCode Linting and ESlint woring -- show Issues multiples times in Editor

• ESLint not able to catch issues, but VSCode Lint able to catch those

• Example : ESLint not able to catch variable redeclare Issue
  

[prod] Deployment setup

• https://www.npmjs.com/package/morgan#log-file-rotation

[find] Check if `cors` can be removed without any sideffect

• REF: https://www.npmjs.com/package/cors

Custom CORS handling Code Example

app.use((req, res, next) => {
  res.header("Access-Control-Allow-Origin", "*");
  res.header(
    "Access-Control-Allow-Headers",
    "Origin, X-Requested-With, Content-Type, Accept, Authorization"
  );
  if (req.method === "OPTIONS") {
    res.header("Access-Control-Allow-Methods", "PUT, POST, PATCH, DELETE, GET");
    return res.status(200).json({});
  }
  next();
});

Add Type Definitions to DB Models

• https://mongoosejs.com/docs/typescript.html

---

Apps

• product
• user
• cart
• order
• saved

Other

• Create a Common Interface for Models with _id, createdAt, updatedAt
• Add _id in Model Interfaces

Setup GitHub Actions

Create Docker Image of the server

TODOs

Refactoring

Code Structure Changes

• Separate code into index, server files
• Move common coded to shared folder files
• Separate user into user and auth
• Auth for login, register
• Setup Prettier, ESLint, editorconfig
• Setup Husky
• Error handling, success/fail response sending
• Move code of controller to routes only and separate controller not needed

Implement Image Storage

• Store Images in MongoDB
• Store Images in S3

---

• Make it pluggable, what ever we will set, as a ExpressJS middleware it will store the images there

Add Util to Add Sample Products

Implement Left APIs

Add Request Body, Query Validator

Apps

• product
• user
• cart
• auth
• saved
• order

Implement the DB Operation using common file

• Ref: NodeJS-CRUD-Operations

Separate routes and controller logic to separate function

• auth
• user
• product
• cart
• saved
• order

---

• Also re-use Product Create Controller to Add Product from Utils

Add Custom HTTP Exceptions