ricardo-melo-martins / typescript-skeleton

⚡ RMM ⚡ Typescript Standard and basic structure to assist in the quick start of tests, projects, pocs with this technology.

⚡ RMM ⚡

^{thank you for visiting! 🙌🤗⭐}

Typescript Skeleton

This is a basic framework, a minimalist template using Typescript. It assists me in the quick start to create tests, POC or projects.

Simple can be harder than complex: You have to work hard to get your thinking clean to make it simple. But it's worth it in the end because once you get there, you can move mountains. ~Steve Jobs

Features

• Typescript 5.3+ is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
• ESLint statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your continuous integration pipeline.
• Prettier is an opinionated code formatter.
• Nodemon is a utility, that will monitor for any changes in your source and automatically restart your server. Perfect for development.
• ts-node is a TypeScript execution engine and REPL for Node.js.
• @types/node - This package contains type definitions for node (https://nodejs.org/).
• EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.
• TypeDoc Automatic document generation
• npm-check-updates upgrades your package.json dependencies to the latest versions, ignoring specified versions.

How to use

Make a repository

• Click here to generate with this template ^❓
• Edit the package.json with your desired stuff

Or clone template to your system

git clone [e-mail]:ricardo-melo-martins/typescript-skeleton.git

# access the folder
cd typescript-skeleton 

# make it yours
rm -rf .git

How to Install

Install dependencies

# Node.js >=20 is required
npm i
# or 
yarn

Run the project for local development.

npm dev
# or 
yarn dev

Build the project for a production environment.

npm run build

Check the latest versions of all project dependencies:

npm run check

Checking ...\typescript-skeleton\package.json
[====================] 13/13 100%

All dependencies match the latest package versions :)

Package.json

Available commands for:

Build

• build - Build one or more projects and their dependencies
• build:watch - Watch input files
• build:release - Build specified settings on tsconfig.release.json
• prebuild - Checks possibility

Execution

• start - Run static compiled on path dist
• start:dev - Run nodemon on path src
• start:prod - Run production env on path dist

Code style

• format - Prettier format code style
• lint - ESLint code format verify
• lint:fix - ESLint verify and fix

Clean

• clean - Remove cache, coverage and dist folder

Docs

• doc:gen - Automatic document generate
• doc:clean - Delete doc folder

Packages

• check - Check the latest versions of all project dependencies

System requirements

• Node 20+
• Typescript Cli
• Vscode (Optional) This template has productivity-focused settings, snippets and extensions.

VSCode

Formatting/Linting

Install dbaeumer.vscode-eslint extension in your VS Code to use eslint for formatting and linting. A configuration file (.eslintrc.js) is already provided in the project.

License

Typescript Skeleton is MIT licensed.

Author

Created with fun by Ricardo Melo Martins.

_{I thank ❤️ the teams of}