README.md

typescript-template

Template for typescript project with preconfigured settings.

How to use this project?

Use this project as a template to expedite the process to set up a typescript project.

The project can be either used as:

1. A package used by other projects
2. Run as a script project.

Install

yarn

Run the script

Run typescript file src/scripts/index.ts

yarn run

Build the project

# Build this project
yarn build

# Build in watch mode
yarn build:watch

Used as a package used

Use as local dependency

# Using this project
yarn add file:<path-to-this-project>

Dev watch mode

# Under this project
yarn link
yarn build:watch

# Other project using this project
yarn link <package-name>