An open API service indexing awesome lists of open source software.

https://github.com/jasterv/node-ts-template

A template for nodejs projects with configuration files for typescript support
https://github.com/jasterv/node-ts-template

Last synced: 11 months ago
JSON representation

A template for nodejs projects with configuration files for typescript support

Awesome Lists containing this project

README

          

Welcome to node ts template 👋




License: MIT

> A template for typescript nodejs projects with configuration files such as
> tsconfig & eslint.

## ESLint

Extends the airbnb javascript styleguide adding also typescript support.
Generated with `npx eslint --init`

## tsconfig.json

This tsconfig.json comes from
[Ben awad recommended tsconfig](https://github.com/benawad/tsconfig.json) Thanks
Ben <3

## Jest

jest.json configured to handle *.test.ts files under the tests & src folders.
Also we use ts-jest to run our tests without compiling typescript to javascript

## package.json

I use ts-node-dev to run my code on development mode as it is super fast (sorry
nodemon I don't need you anymore)

## Prettier

I don't think I need prettier as this ESLint config works totally fine for me.
If you want to make a pull request adding ESLint prettier config you are welcome

## .gitignore

.gitignore generated with gitignore.io, works fine without any further change :D

## Github action

I've just added the default nodejs github workflow as it works perfectly fine
for simple nodejs projects (Just install dependencies, build & test)

## Husky

I love husky as it can automate jobs on any git command such as executing tests
each time you create a commit

## Author

👤 **Victor Martinez**

- Github: [@JasterV](https://github.com/JasterV)
- LinkedIn: [@Victor Martinez](https://linkedin.com/in/victor-martinez-montane)

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2021 [Victor Martinez](https://github.com/JasterV).
This
project is [MIT](https://mit-license.org/) licensed.

---

_This README was generated with ❤️ by
[readme-md-generator](https://github.com/kefranabg/readme-md-generator)_