https://github.com/stephen-shopopop/node-ts-eslint

Nodejs template with eslint configuration
https://github.com/stephen-shopopop/node-ts-eslint

backend eslint javascript makefile nodejs prettier tslint typescript

Last synced: 3 months ago
JSON representation

Nodejs template with eslint configuration

• Host: GitHub
• URL: https://github.com/stephen-shopopop/node-ts-eslint
• Owner: stephen-shopopop
• Created: 2022-02-08T11:07:44.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-08T21:02:50.000Z (over 3 years ago)
• Last Synced: 2025-02-21T14:41:20.321Z (over 1 year ago)
• Topics: backend, eslint, javascript, makefile, nodejs, prettier, tslint, typescript
• Language: TypeScript
• Homepage: https://stephen-shopopop.github.io/node-ts-eslint/
• Size: 485 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
[![Minimal node version](https://img.shields.io/static/v1?label=node&message=%3E=16.18.1&logo=node.js&color)](https://nodejs.org/about/releases/)

[![Minimal npm version](https://img.shields.io/static/v1?label=npm&message=%3E=6.14.12&logo=npm&color)](https://github.com/npm/cli/releases)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/stephen-shopopop/ts-node-eslint/graphs/commit-activity)

[![Linux](https://svgshare.com/i/Zhy.svg)](https://svgshare.com/i/Zhy.svg)

[![macOS](https://svgshare.com/i/ZjP.svg)](https://svgshare.com/i/ZjP.svg)

[![Visual Studio Code](https://img.shields.io/badge/--007ACC?logo=visual%20studio%20code&logoColor=ffffff)](https://code.visualstudio.com/)

# NODEJS typescript template:

## Description

Template for typescript with ESLint configuration

## Installation nodejs via nvm (node version manager)

- [macos/linux](https://github.com/nvm-sh/nvm) or use Makefile command: ```make nvm```

- [windows](https://github.com/coreybutler/nvm-windows)

## Contributing

1. npm run build - Build library.

2. npm run start - start project

3. npm run dev - start projet with ts-node (dev)

4. npm run test - Run test with jest.

5. npm run lint - Lint your code.

6. npm run lint:fix - Lint fix your code.

7. npm run typecheck - Run typescript check.

8. npm run doc - Generate html doc.

9. npm run release - Release library

10. npm run fix - Fix library

## Production

```bash

npm i --production

npm start

```

## Docs

### Summary

- [Apprendre nodejs](https://github.com/stephendltg/nodebook)

- [Apprendre typescript](https://www.typescriptlang.org/fr/)

- [Typescript configuration](https://github.com/tsconfig/bases)

- [Reference javascript](https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference)

- [ECMA-262](https://www.ecma-international.org/publications-and-standards/standards/ecma-262/)

- [summary of the new ES version by example](https://github.com/gautemo/ES-Intro)

- [Nodejs best practices](https://github.com/goldbergyoni/nodebestpractices)

- [Nodejs testing best practices](https://github.com/goldbergyoni/javascript-testing-best-practices)

- [Structure nodejs project](https://github.com/elsewhencode/project-guidelines)

- [NPM documentation](https://docs.npmjs.com/cli/v8/commands)

- [Package.json documentation](https://docs.npmjs.com/cli/v8/configuring-npm/package-json)

- [Apprendre Git](https://www.atlassian.com/fr/git/tutorials/setting-up-a-repository)

- [Git conventions](conventions.md)

- [library & tools](tools.md)

### VSCODE Addons

- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

- [jest runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner)

- [thunder client](https://marketplace.visualstudio.com/items?itemName=rangav.vscode-thunder-client)

- [git lens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)

### Package maintenance

A modern cli tool that keeps your deps fresh

```bash

npx taze

```