/typescript-node-boilerplate

A boilerplate for a typescript project so you could get started quicker without using any weird tools

Primary LanguageTypeScriptThe UnlicenseUnlicense

Typescript+Node.js boilerplate

A boilerplate for a typescript project so you could get started quicker without using any weird tools. Perfect if you use git and vscode.

License

This project is licensed under the Unlicense license, so you can choose whatever license you want.

Installation

Prerequisites

  • Use linux
  • Have the following things installed: node, yarn, git, tsc and Visual Studio Code.

Clone the repository

git clone https://github.com/wait-what/typescript-node-boilerplate.git my-project

Go into your project directory

cd my-project

Install dependencies

yarn

Configure git

  • Reset the git repository:
rm -rf .git
git init
  • Set the origin:
git remote set-url origin https://github.com/username/my-project.git

Choose a licence

  • Delete the existing LICENSE file, unless you wish to keep the Unlicense license.
  • Pick the license you want from here: list of open source licenses

Edit package.json

  • Set the correct license string
  • Set the author name
  • Set the repository url (if you want to use git)

Write a README.md

  • Describe your project briefly at the top
  • Explain how to run and use your program
  • Mention which license it's licensed under

Running

Press F5 (if you're using VSCode) to start your application. Magic!