lib-ts

A library boilerplate with TypeScript.

Features

Getting Started

Prerequisites

• Node.js: Latest LTS version.
• npm: Should follow the version of Node.js.
• TypeScript: Latest LTS version.
• ESLint: Latest LTS version.
• Prettier: Latest LTS version.

Installation

1. Clone the repository:

   git clone https://github.com/leehpham/lib-ts.git <project-folder-name>
   

2. Remove .git:

   rm -rf .git

3. Remove package-lock.json:

   rm package-lock.json

4. Rename "name" field in package.json to your <project-folder-name>.

5. Install packages

   npm install

6. (Optional) Update packages and set their version in package.json:

   npm update --save

7. Run tests to make sure everything is working:

   npm run test

8. Update the content of README.md and documentation in docs folder to your liking.

Scripts

• npm run build: Build the application. The output .js files will be in the dist folder.
• npm run build:watch: Build in watch mode.
• npm run lint: Lint files src folder. This needs to be updated to also lint test files in __tests__ folder.
• npm run lint:fix: Fix linting issues for files in src folder.
• npm run test: Run all tests.
• npm run test:watch: Run all tests in watch mode.
• npm run test:learning: Run learning tests.
• npm run test:learning:watch: Run learning tests in watch mode.
• npm run test:unit: Run unit tests.
• npm run test:unit:watch: Run unit tests in watch mode.

Documentation

• Architecture Overview
• Environment Configuration
• Node.js Configuration
• TypeScript Configuration
• Testing Guide
• Contribution Guidelines
• Dependencies
• Backlog

License

This project is licensed under the ISC License.