luizfx22 / typescript-boilerplate Goto Github PK

I set this up to be used in the development of console applications!

If you're looking for a React boilerplate, this project doesn't supply your needs.

This project was built to help new developers (or some more experienced developers) to get started easily and reliable in a new TypeScript project, providing a bunch of features that helps development and building for deploy!

• ESLint (AirBnb style)
• Prettier
• EditorConfig
• WebPack
• Complete tsconfig.json file

✔ This project comes with ESLint fully set up, no time wasted setting up this.

✔ Fully set up to quickly turn your code into a masterpiece.

Quick note: If you're using VSCode, remeber installing both ESLint and Prettier extensions and setting up you VSCode to automatically fix the code when you save it

✔ Build your entire codebase into a single ES6 file, wich you can start by running node dist/index.js

setup-npm: Installs everything you need to begin your project:

$ npm run setup-npm

setup-yarn: If your the kind which use Yarn (by the way, you're completely right in doing this) you could run:

$ npm run setup-yarn

dev: Starts a nodemon to run you app in development mode

$ npm run dev
# or
$ yarn dev

build: Builds your project for production, the files will be located in dist directory

$ npm run build
# or
$ yarn build

check-updates: Checks for updates in dependencies

$ npm run check-updates
# or
$ yarn check-updates

update: Apply the updates and run npm to install

$ npm run update
# or
$ yarn update