TypeScript Project Template

About

A TypeScript template created by DmmD GM.

Prerequisites

• Git

# Verification
git -v

• Node.js

# Verification
node -v

• Prettier

# Installation
npm install -g prettier
sudo npm install -g prettier

# Verification
prettier -v

• TypeScript

# Installation
npm install -g typescript
sudo npm install -g typescript

# Verification
tsc -v

Visual Studio Code

• Eslint
• Prettier

Installation

1. Create a new repository from this template.

2. Clone the new repository to your desktop:

git clone your-repository-url your-project/

3. Change your current working directory to your project:

cd your-project/

4. Set up your project:

./scripts/setup.sh

Additional Resources

• Eslint
• Git
• Node.js
• Prettier
• TypeScript

Scripts

• scripts/build.sh

Formats and statically analyzes your TypeScript files in the src/ directory before compiling them into JavaScript files.

• scripts/format.sh

Formats and statically analyzes your entire project, which includes non-TypeScript files such as package.json or README.md.

• scripts/publish.sh <message>

Publishes your code to Github with the message attached.

• scripts/setup.sh

Installs necessary npm packages and formats the project automatically.