Skip to content

Project template to kick off your Node.js TypeScript application. Biome for formatting and linting, vitest for speedy testing, and Postgres together with pgweb included.

License

Notifications You must be signed in to change notification settings

owre/node-typescript-postgres-template

Repository files navigation

owre/node-typescript-postgres-template

Project template to kick off your Node.js TypeScript application. Biome for formatting and linting, vitest for speedy testing, and Postgres together with pgweb included.

Features

  • DevContainer: For a consistent and stable development environment.
  • TypeScript: Leverage static types and modern JavaScript features. Aliased paths are set up for easy imports of your modules and properly rewritten during build thanks to typescript-transform-paths.
  • ESM: Utilize ECMAScript modules for better interoperability.
  • Biome: Format, lint, and more in a fraction of a second. No more wasting your time (and sanity) getting ESLint to work.
  • Vitest: A next generation, Jest compatible, testing framework. Enables speedy and efficient testing.
  • Postgres with pgweb: The World's Most Advanced Open Source Relational Database included together with pgweb for seamless database management. Access the web interface at port 8082.
  • Lefthook Fast, powerful and simple git hooks manager

Prepared npm scripts

  • start - run src/main.ts with tsx
  • start:dist - run built project at dist/src/main.js with node,
  • clean - deletes dist and coverage directories,
  • prebuild - automatically runs clean, lint and test scripts when running build
  • build - builds project using release configuration
  • lint - uses biome to lint the project
  • prepare - automatically runs when dependencies are installed
  • test - runs test files,
  • test:coverage - gather test coverage
  • test:watch - runs test files in watch mode
  • typecheck - convenient helper to check the type integrity in the project

About

Project template to kick off your Node.js TypeScript application. Biome for formatting and linting, vitest for speedy testing, and Postgres together with pgweb included.

Topics

Resources

License

Stars

Watchers

Forks