https://github.com/ricardo-melo-martins/typescript-skeleton
⚡ RMM ⚡ Typescript Standard and basic structure to assist in the quick start of tests, projects, pocs with this technology.
https://github.com/ricardo-melo-martins/typescript-skeleton
boilerplate node-typescript-template nodejs project-template starter-project starter-template typescript-boilerplate typescript-template
Last synced: 4 months ago
JSON representation
⚡ RMM ⚡ Typescript Standard and basic structure to assist in the quick start of tests, projects, pocs with this technology.
- Host: GitHub
- URL: https://github.com/ricardo-melo-martins/typescript-skeleton
- Owner: ricardo-melo-martins
- License: mit
- Created: 2024-02-22T18:57:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-26T01:40:52.000Z (over 1 year ago)
- Last Synced: 2025-01-15T17:37:43.520Z (5 months ago)
- Topics: boilerplate, node-typescript-template, nodejs, project-template, starter-project, starter-template, typescript-boilerplate, typescript-template
- Language: TypeScript
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#### ⚡ **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+](https://www.typescriptlang.org/) is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
- [ESLint](https://eslint.org/) 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](https://prettier.io/) is an opinionated code formatter.
- [Nodemon](https://nodemon.io/) is a utility, that will monitor for any changes in your source and automatically restart your server. Perfect for development.
- [ts-node](https://typestrong.org/ts-node/) is a TypeScript execution engine and REPL for Node.js.
- [@types/node](https://www.npmjs.com/package/@types/node) - This package contains type definitions for node ().
- [EditorConfig](https://editorconfig.org/) helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.
- [TypeDoc](https://typedoc.org) Automatic document generation
- [npm-check-updates](https://github.com/raineorshine/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](https://github.com/ricardo-melo-martins/typescript-skeleton/generate) with this template [❓](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
- Edit the package.json with your desired stuff
### Or clone template to your system
```bash
git clone [email protected]:ricardo-melo-martins/typescript-skeleton.git
# access the folder
cd typescript-skeleton
# make it yours
rm -rf .git
```
## How to Install
Install dependencies
```bash
# Node.js >=20 is required
npm i
# or
yarn
```
Run the project for local development.
```bash
npm dev
# or
yarn dev
```
Build the project for a production environment.
```bash
npm run build
```
Check the latest versions of all project dependencies:
```sh
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](https://nodejs.org/en/download) 20+
- [Typescript Cli](https://www.typescriptlang.org/download)
- [Vscode](https://code.visualstudio.com/) *`(Optional)`* This template has productivity-focused settings, snippets and extensions.
## VSCode
Formatting/Linting
Install [dbaeumer.vscode-eslint](https://marketplace.visualstudio.com/items?itemName=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](LICENSE).
## Author
Created with fun by [Ricardo Melo Martins](https://github.com/ricardo-melo-martins).
I thank :heart: the teams of
