An open API service indexing awesome lists of open source software.

https://github.com/situ2001/typescript-jest-template

personal use, for quickly implementing ideas in a TDD fashion.
https://github.com/situ2001/typescript-jest-template

jest nodejs tdd template typescript

Last synced: 8 months ago
JSON representation

personal use, for quickly implementing ideas in a TDD fashion.

Awesome Lists containing this project

README

          

# typescript-jest-template

![](idea.png)

This is a template for quickly implementing ideas in a TDD fashion.

## Motivation

Sometimes I want to write something that comes in my mind, but I don't want to spend time on setting up the environment. This template is for that purpose.

## Usage

Just use this template to create a new repository.

After creating the repository, clone it to your local machine. Then, install the dependencies.

```shell
yarn
```

After that, you can start writing your code. The source codes are in `src` directory. The test codes are in `__tests__` directory.

If you want to run the tests, run the following command.

```shell
yarn test
```

If you want to build the source codes, run the following command.

```shell
yarn build
```

If you want to directly run typescript code, run the following command.

```shell
npx ts-node src/.ts
```

Enjoy!

## License

This repository is licensed under the MIT license. See [LICENSE](LICENSE) for details.