Best practices and modular structuring for an enterprise-level Node.js API project using TypeScript:
Step 1: Project Initialization and Dependency Installation
mkdir my-typescript-api
cd my-typescript-api
npm init -y
npm install typescript express dotenv helmet cors
npm install --save-dev @types/node @types/express @types/cors ts-node nodemon eslint| https://sokra.github.io/interop-test/ | |
compilerOptions:
target: Specifies the ECMAScript target version (e.g., ES5, ES6, etc.).module: Specifies the module system (e.g., CommonJS, ES6, etc.).strict: Enables strict type checking options.esModuleInterop: Ensures compatibility between CommonJS and ES module imports.include:
| ### Create an action like this | |
| ------ | |
| name: ACTION NAME | |
| on: | |
| workflow_dispatch: | |
| ### install github cli |
| yarn init -y | |
| yarn add normalize-scss | |
| yarn add --dev stylelint stylelint-config-sass-guidelines stylelint-config-prettier stylelint-prettier prettier | |
| yarn add --dev husky lint-staged | |
| .stylelintrc.json | |
| { |
| { | |
| "configurations": [ | |
| { | |
| "args": [ | |
| "${workspaceFolder}/spec/*.spec.js", | |
| "--require", | |
| "@babel/register" | |
| ], | |
| "internalConsoleOptions": "openOnSessionStart", | |
| "name": "Mocha Tests", |
| # Install | |
| Download win 64 bit from https://www.rust-lang.org/tools/install | |
| ### Run the installer. It will launch a command prompt | |
| The Cargo home directory located at: | |
| C:\Users\gs\.cargo |
| // get ps version | |
| Get-Host | Select-Object Version | |
| $PSVersionTable.PSVersion | |
| // get azure powershell version | |
| Get-Module -ListAvailable -Name Az | |
| Get-Module -ListAvailable -Name Azure -Refresh | |
| // get apim services |
| npx npm-check-updates -u --timeout 120000 | |
| npm install |
| Javascript | |
| ----------------- | |
| https://github.com/systemjs/systemjs | |
| SystemJS is a hookable, standards-based module loader. It provides a workflow where code written for production workflows of native ES modules in browsers (like Rollup code-splitting builds), can be transpiled to the System.register module format to work in older browsers that don't support native modules, running almost-native module speeds while supporting top-level await, dynamic import, circular references and live bindings, import.meta.url, module types, import maps, integrity and Content Security Policy with compatibility in older browsers back to IE11. |