Welcome to nodets-boilerplate 👋

A basic boilerplate for any NodeJS + Typescript projects with a few packages to get started right away

Install

git clone https://github.com/TimoZacherl/nodets-boilerplate.git
npm install

Usage

Typescript code should be written in the src folder and will be compiled into the dist folder. (Could be changed in the configs)

npm run build

builds javascript code for production build into dist folder

npm run start

runs build script and starts the server

npm run start:dev

watches typescript source code and compiles on change whilst dev server is live

npm run lint

checks if code has any errors, which are described in the .eslintrc file with eslint

npm run lint-and-fix

runs eslint and fixes errors if possible

npm run prettier-format

formats code as described in .prettierrc

npm run prettier-watch

watches code and formats it on change

Basic configurations for eslint, prettier, typescript and nodemon are contained in this repo.

Author

👤 Timo Zacherl

• Website: https://timozacherl.com
• Twitter: @timoxdev
• Github: @timozacherl

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Timo Zacherl.
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator