readme.md

TypeScript Express API Bootstrap (base / project starter)

This is a repository intended to serve as a starting point if you want to bootstrap a express API project in TypeScript.

Features

• TypeScript (v4)
• ts-node-dev
• Prettier
• ESLint with:
  • Codely's config (includes ESLint's recommended rules, Prettier, Import plugin and more)
  • Jest plugin
• Jest with DOM Testing Library
• GitHub Action workflows set up to run tests and linting on push

Running the app

# install dependencies
npm install

# run in dev mode on port 3000
npm run dev

# generate production build
npm run build

# run generated content in dist folder on port 3000
npm run start

Testing

Jest with supertest

npm run test

Linting

# run linter
npm run lint

# fix lint issues
npm run lint:fix