node-express-mvc

• The Node-express server template with TypeScript and MVC architecture

Node Specification

• Node 20.11.0 (Installed on January 28, 2024)

Packages

Global Packages

• npm 10.4.0

Project Packages

• express 4.18.2
• dotenv 16.4.1
  • This can be removed, Node 20.6.0 has built-in support for .env file
• inversify 6.0.2
• @prisma/client 5.9.1 by prisma migrate
• bcrypt 5.1.1
• swagger-ui-express 5.0.0
• swagger-jsdoc 6.2.8

Dev Packages

• typescript 5.3.3
• ts-node 10.9.2
• nodemon 3.0.3
• ncp 2.0.0
  • Used for copying /public folder into /dist folder with pure node command
• eslint 8.56.0
• jasmine 5.1.0
• prisma 5.9.1

Express Settings

• Project created by express-generator
• View engine: None
• Style sheet engine: Plain CSS

App Environments

• Manage the environment using dotenv
• Modify .env file to update environments

Usages

Initialize the project

• Install node modules before run project

npm install

Start server with dev mode

• Run server on localhost with watching file changes using ts-node and nodemon

npm run dev

Start server with dev mode (VSCode)

• Create /.vscode/launch.json file with the following contents

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch via NPM",
            "request": "launch",
            "runtimeArgs": [
                "run-script",
                "dev"
            ],
            "runtimeExecutable": "npm",
            "skipFiles": [
                "<node_internals>/**"
            ],
            "type": "node"
        }
    ]
}

• Run VSCode debug with Launch via NPM
• See also Node.js debugging in VS Code

Linting the source code

• Run ESLint for typescript codes in project

npm run lint

Testing the test code

• Run Jasmine with typescript spec codes
• Write the spec codes in /spec folder

npm run test

Build server

• Compile application sources from typescript to javascript using tsc in typescript
• Also, this command copies the /public folder into /dist for build includes the asset files

npm run build

Start server

• Start server with compiled javascript sources

npm run start

Todo List

1. Add model validate from request object.
2. Add scripting tutorial
3. Add redis handling solution