https://github.com/casantosmu/quick-ts-esm-setup

Quick TypeScript ES Modules setup for projects.
https://github.com/casantosmu/quick-ts-esm-setup

boilerplate eslint esm esmodules node nodejs prettier template typescript vitest

Last synced: 2 days ago
JSON representation

Quick TypeScript ES Modules setup for projects.

• Host: GitHub
• URL: https://github.com/casantosmu/quick-ts-esm-setup
• Owner: casantosmu
• License: mit
• Created: 2023-10-02T19:04:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-08T01:46:03.000Z (10 months ago)
• Last Synced: 2024-04-08T02:48:22.276Z (10 months ago)
• Topics: boilerplate, eslint, esm, esmodules, node, nodejs, prettier, template, typescript, vitest
• Language: TypeScript
• Homepage:
• Size: 653 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Quick TS ESM Setup

> Quick TypeScript ES Modules setup for projects

This repository provides a default configuration to quickly start TypeScript projects with ES Modules. It comes with minimal Prettier, ESLint, and test configurations, along with features like automatic server restart, environment variables support, debug mode, and Git hooks. Additionally, it provides VSCode extensions and settings recommendations.

## Installation

1. Clone this repository: `git clone https://github.com/casantosmu/quick-ts-esm-setup.git`

2. Navigate to the project directory: `cd quick-ts-esm-setup`

3. Install the dependencies: `npm install`

## Configuration

Before starting your project, please make the following changes:

- Change the name of the project in `package.json`.

- Clean Git history:

  - Remove the existing Git repository by deleting the `.git` folder.

  - Initialize a new Git repository: `git init`.

  - Make an initial commit: `git add .` and `git commit -m "Initial commit"`.

- Update the README.md:

  - Modify the content of the README.md file to provide information about your project.

- (Optional) Remove or modify any additional files, such as workflows, that are not needed for your project.

## Usage

- `npm start`: Start the application.

- `npm run build`: Compile TypeScript code into the `dist` folder.

- `npm run dev`: Start the application in development mode with automatic restart, debug mode, and environment variables loaded from `.env`.

- `npm test`: Run the test suite with loaded environment variables from `.env`

- `npm run test:coverage`: Run the test suite with code coverage analysis.

- `npm run lint`: Run Prettier to check code formatting and ESLint for static code analysis.

- `npm run format`: Automatically format the code with Prettier.

- `npm run typecheck`: Run TypeScript type checking.

- `npm run prepare`: Install Husky Git hooks.

## License

This project is licensed under the [MIT License](LICENSE).