https://github.com/metonym/template-typescript-nodemon

Develop projects with nodemon and TypeScript
https://github.com/metonym/template-typescript-nodemon

nodemon template typescript

Last synced: about 1 month ago
JSON representation

Develop projects with nodemon and TypeScript

• Host: GitHub
• URL: https://github.com/metonym/template-typescript-nodemon
• Owner: metonym
• License: mit
• Created: 2019-06-14T15:56:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:48:52.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T20:06:28.683Z (over 1 year ago)
• Topics: nodemon, template, typescript
• Language: TypeScript
• Homepage:
• Size: 1.26 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# template-typescript-nodemon

[![Build][build]][build-badge]

[![Coverage][codecov-shield]][codecov]

> Develop TypeScript projects using [nodemon](https://github.com/remy/nodemon).

This project provides basic scaffolding for developing and building TypeScript libraries using [nodemon](https://github.com/remy/nodemon) and [ts-node](https://github.com/TypeStrong/ts-node).

## Getting Started

Clone the template and install its dependencies:

```bash

git clone [email protected]:metonym/template-typescript-nodemon.git

cd template-typescript-nodemon

yarn install

```

## Available Scripts

### `yarn develop`

Runs the project in development mode and watches for any changes.

### `yarn build`

Builds the project for production. The build directory is `dist`; types will be written to `dist/index.d.ts`. Customize the build directory in the `outDir` configuration option in the [tsconfig.json](tsconfig.json).

### `yarn test`

Runs test suites and generates a coverage report.

### `yarn test:tdd`

Runs tests in Test-driven Development (TDD) mode.

## Customizing Nodemon

Modify the nodemon configuration in the `nodemonConfig` field in package.json. By default, the entry is `src/index.ts`. Only files within the `src` folder are watched for changes.

```json

"nodemonConfig": {

  "exec": "ts-node src/index.ts",

  "env": {

    "NODE_ENV": "development"

  },

  "ext": "ts",

  "watch": [

    "src"

  ]

}

```

## Linting, formatting and committing

To ensure that committed code follows conventions, this project uses `prettier`, `tslint` and git hooks (via `husky`) to automate the linting and formatting of code and commit messages.

## Continuous Integration

This template uses `Travis CI` to build and test remote changes.

## License

[MIT](LICENSE)

[build]: https://travis-ci.com/metonym/template-typescript-nodemon.svg?branch=master

[build-badge]: https://travis-ci.com/metonym/template-typescript-nodemon

[codecov]: https://codecov.io/gh/metonym/template-typescript-nodemon

[codecov-shield]: https://img.shields.io/codecov/c/github/metonym/template-typescript-nodemon.svg