# create-nodejs-ts

> NodeJS Starter Project Kit

Latest version **3.0.2** (published 2022-06-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-nodejs-ts
pnpm add create-nodejs-ts
yarn add create-nodejs-ts
bun add create-nodejs-ts
```

Provides the command `create-nodejs-ts`.

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2022-06-29 |
| First published | 2021-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 78.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 161 |
| Author | Vitor Hugo Salgado |
| Maintainers | vitor.salgado |
| Keywords | nodejs, nodejs-boilerplate, typescript, typescript-boilerplate, starter, boilerplate, scaffold, template |

## Links

- npm: https://www.npmjs.com/package/create-nodejs-ts
- Repository: https://github.com/vitorsalgado/create-nodejs-ts
- Homepage: https://github.com/vitorsalgado/create-nodejs-ts#readme
- Issues: https://github.com/vitorsalgado/create-nodejs-ts/issues
- npm.io page: https://npm.io/package/create-nodejs-ts

## Dependencies (3)

- [tslib](https://npm.io/package/tslib.md) ^2.3.1
- [dotenv](https://npm.io/package/dotenv.md) ^16.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.1

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 3.0.2 (latest) — 2022-06-29
- 3.0.1 — 2022-05-05
- 3.0.0 — 2022-03-30
- 2.1.0 — 2022-02-04
- 2.0.1 — 2022-01-12
- 2.0.0 — 2021-12-28
- 1.2.2 — 2021-10-08
- 1.2.1 — 2021-08-10
- 1.2.0 — 2021-07-24
- 1.1.0 — 2021-07-20
- 1.0.0 — 2021-07-20

## README

<h1 align="center">Node.js Starter ToolKit</h1>

<p align="center">
    <i>Starter Project for a Node.js application using <strong>TypeScript</strong> with all boring stuff already configured.</i>
</p>

<p align="center">
  <a href="https://github.com/vitorsalgado/create-nodejs-ts/actions/workflows/ci.yml">
    <img src="https://github.com/vitorsalgado/create-nodejs-ts/actions/workflows/ci.yml/badge.svg" alt="GitHub Action Status" />
  </a>
  <a href="https://www.npmjs.com/package/create-nodejs-ts">
    <img src="https://img.shields.io/npm/v/create-nodejs-ts.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen" alt="npm" />
  </a>
  <a href="https://github.com/prettier/prettier">
    <img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat" alt="Prettier"/>
  </a>
  <a href="https://conventionalcommits.org">
    <img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits"/>
  </a>
</p>

## Overview

Starter project for **Node.js** applications using **TypeScript** with test, lint, code formatter already configured.
Check the [tooling](#tooling) section for more details.  
The preferable way to use this boilerplate is using `npx` command. You can use `npm init` too.  
Use the following commands to bootstrap a new project:

### NPX

```
npx create-nodejs-ts --no --app=your-app
```

### NPM Init

```
npm init nodejs-ts -- --app=your-app
```

Without parameters, the project will be created on a folder **my-app** in the same directory where you executed the
command.  
All parameters available:

```
--destination=<FOLDER_DESTINATION> Defaults to the current directory
--app=<APP_NAME> Defaults to my-app
```

The final folder will the parameter `destination`, if provided, concatenated with the parameter `app`.

## ESM

The project template now uses **ESM** by default.

## Docker

Minimalist docker image generation.  
Check this [Dockerfile](build/docker/Dockerfile).

## Local Dev Environment

Run `make up` to spin up a local environment with **Docker Compose**.  
Check this [docker-compose.yml](deployments/dev/docker-compose.yml) for more details.

## Tooling

- ESM
- TypeScript
- Jest
- EsLint
- Husky
- Commit Lint
- Lint Staged
- Prettier
- Nodemon
- Docker | Docker Compose

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fvitorsalgado%2Fnodejs-boilerplate.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fvitorsalgado%2Fnodejs-boilerplate?ref=badge_shield)

This project is [MIT Licensed](LICENSE).

---
_Source: https://npm.io/package/create-nodejs-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._