README.md

TypeScript Bootstrap (base / project starter)

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

Features

• TypeScript (v4)
• Webpack (v5)
• Babel with preset-env
• Prettier
• ESLint with:
  • Codely's config (includes ESLint's recommended rules, Prettier, Import plugin and more)
  • HTML plugin
  • Jest plugin
  • Cypress plugin
• Jest with DOM Testing Library
• Cypress with 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 8080
npm run dev

# generate production build
npm run build

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

Testing

Jest with Testing Library

npm run test

Cypress

# run in dev mode on port 8080
npm run dev

# open Cypress to run tests on dev mode
npm run cy:open

# open Cypress on CLI
npm run cy:run

Linting

# run linter
npm run lint

# fix lint issues
npm run lint:fix