Giter VIP home page Giter VIP logo

nodets-boilerplate's Introduction

Welcome to nodets-boilerplate ๐Ÿ‘‹

Version License: MIT Twitter: timoxdev

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

๐Ÿค 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!

Buy Me A Coffee

๐Ÿ“ License

Copyright ยฉ 2020 Timo Zacherl.
This project is MIT licensed.


This README was generated with โค๏ธ by readme-md-generator

nodets-boilerplate's People

Contributors

dependabot[bot] avatar lovetodream avatar

Stargazers

 avatar

Watchers

 avatar

nodets-boilerplate's Issues

Update readme

Provide information about preinstalled packages, configurations and usage example

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.