search

timelessco / node-ts-library-template

This project is a template for creating a nodejs library written in typescript that can be used in production.
https://github.com
MIT License
0 stars 0 forks source link
library node production template ts

readme

Introduction

This project is a node library package written in typescript built using tsup. tsup is a modern build tool for modern node applications, designed for performance and ease of use. It allows you to focus on writing code and not on the build process.

Setup

To get started with this project, follow these steps:

  1. Clone the repository:
git clone https://github.com/timelessco/node-ts-library-template
  1. Install the dependencies:
pnpm install
  1. Start the development server:
pnpm run dev

This will start a nodemon watch server with ts-node, and you can view the changes in your cli. Any changes you make to the code will be automatically reloaded in the cli.

Build

To build the project for production, run the following command:

pnpm run build

This will generate a production-ready build library in the lib folder.

Other Commands

In addition to the dev and build commands, there may be other commands available, such as:

lint: Run the linters & formatters to check the code for style and syntax errors.

format: Run the linters & formatters to check the code for style and syntax errors. If any errors are found, they will be fixed automatically.

test: Run the test suite for the project.

commit: Run the commit wizard to generate a commit message.

release: Run the release-it tool to generate a new release.

License

This project is licensed under the MIT License.