alexmarqs / node-typescript-starter

✨ Simple Node Typescript Starter

Simple Node Typescript Starter

A node.js starter project using TypeScript.

Technologies

• Typescript (selected ES2020 as target because I assume Node.js version 14 or higher is being used, please change the configuration for whatever version you want to use)
• Node.js
• ts-node-dev for live reloading during development
• dotenv to load environment variables only for development (preload approach is being used)
• ESLint + Prettier + Husky
• Yarn
• jest for testing + ESLint Plugin + Coverage

Basic scripts

yarn test

Runs tests

yarn test:dev

Runs tests in development mode which will include coverage and live reloading

yarn build

Builds the project for production mode

yarn dev

Runs the project in development mode (live reloading)

yarn start

Starts the project in production mode (this expects that all the environment variables are set in the runtime environment)

yarn lint

Runs the linter

yarn lint:fix

Runs the linter and fixes the issues

yarn format

Formats the code

(other scripts are available in the scripts section of the package.json)

License

MIT License © alexmarqs