/node-express-ts-stater

A Stater Node JS Express Stater With TypeScript

Primary LanguageTypeScript

Node JS Express TypeScript Stater

Steps to setup

Init package.json file

npm init -y

Add typescript as a dev dependency

npm install --save-dev typescript

Create tsconfig.json file

npx tsc --init

Create development and production directories

mkdir server src

Define outDir in tsconfig.json file

{
  "compilerOptions": {
    "target": "es2016",
    "module": "commonjs",
    "outDir": "./server",
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "skipLibCheck": true
  }
}

For development purposes install ts-node package as a dev dependency

npm install --save-dev ts-node

Add dev script to package.json file

{
  "scripts": {
    "dev": "nodemon --exec ts-node src/index.ts"
  }
}

Install express

npm i express

Install types for express

npm i @types/express --save-dev

Install dotenv

npm i dotenv

Create following directories

mkdir test # for holding API test files
mkdir ./src/types # for holding types for project
mkdir ./src/routes # for holding routes of API endpoints
mkdir ./src/controllers # for holding controllers of API endpoints