kiq7 / node-ts-starter

Simple Nodejs + Typescript template for start a project.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Nodejs + Typescript Starter

Use only for proof of concepts and studies. Not ready for production code.

Quick Start

Just clone this repository into your own project folder. and start working

git clone https://github.com/kiq7/node-ts-starter.git <MyProjectName>
cd <MyProjectName>
npm install or yarn
npm run dev or yarn dev

If you want to detach from this repository into your own repository do this:

git remote remove origin
git remote add origin YOUR_REPO_URL
git push -u origin master

NPM Scripts

To run your code

npm run start:dev
or
yarn start:dev

To lint your code

npm run lint
or
yarn lint

What's included

  • Typescript
  • Express
  • Nodemon
  • Jest
  • Supertest
  • Linter (ESLint + Standard Style)
  • Editorconfig

Requirements

  • Node 8+

Licence

This code is released as is, under MIT licence. Feel free to use it for free for both commercial and private projects. No warranty provided.

About

Simple Nodejs + Typescript template for start a project.

License:MIT License


Languages

Language:TypeScript 65.1%Language:JavaScript 26.8%Language:Dockerfile 8.2%