https://github.com/sripwoud/ts-template

Typescript Project Template
https://github.com/sripwoud/ts-template

barrelsby biomejs bun docker github-actions husky lint-staged template turbo typescript

Last synced: 8 days ago
JSON representation

Typescript Project Template

• Host: GitHub
• URL: https://github.com/sripwoud/ts-template
• Owner: sripwoud
• License: agpl-3.0
• Created: 2022-11-22T09:37:00.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-08T12:47:58.000Z (28 days ago)
• Last Synced: 2024-10-14T01:09:27.257Z (23 days ago)
• Topics: barrelsby, biomejs, bun, docker, github-actions, husky, lint-staged, template, turbo, typescript
• Language: Dockerfile
• Homepage:
• Size: 381 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

   &nbspPROJECT TEMPLATE






![main GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/sripwoud/ts-template/main.yaml?branch=main&label=main)

[![Coverage Status](https://coveralls.io/repos/github/r1oga/ts-template/badge.svg?branch=main)](https://coveralls.io/github/r1oga/ts-template?branch=main)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)

| Feature                                          | With                                                                  | Configuration File                                                                                                    |

| ------------------------------------------------ | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |

| Runtime, script, tests runner                    | [Bun](https://bun.sh)                                                 | [bunfig.toml](./bunfig.toml)                                                                                          |

| Typings                                          | [Typescript](https://www.typescriptlang.org/)                         | [tsconfig.json](./tsconfig.json)                                                                                      |

| Formatting                                       | [dprint](https://dprint.dev/)                                         | [.dprint.jsonc](./.biome.json)                                                                                        |

| Linting                                          | [Biome](https://biomejs.dev/)                                         | [.biome.jsonc](./.biome.jsonc)                                                                                        |

| Continuous Integration                           | [GitHub Workflow](https://docs.github.com/en/actions/using-workflows) | [.github/workflows](./.github/workflows)                                                                              |

| Import aliases                                   | [Typescript paths](https://www.typescriptlang.org/tsconfig#paths)     | [tsconfig.json](https://github.com/r1oga/ts-template/blob/5d6983a6d28429b9dd256edf40bad5ee48c33d9c/tsconfig.json#L26) |

| Rollup exports                                   | [Barrelsby](https://github.com/bencoveney/barrelsby)                  | [.barrelsby.json](./.barrelsby.json)                                                                                  |

| Containerization                                 | [Docker](https://www.docker.com/)                                     | [Dockerfile](./Dockerfile), [docker-compose.yaml](./docker-compose.yaml)                                              |

| Pre-commit hook (linting, formatting, typecheck) | [lefthook](https://github.com/evilmartians/lefthook/)                 | [.lefthook.yml](./.lefthook.yml)                                                                                      |

## Getting Started

Pre requisites: [bun](https://bun.sh/docs/installation), [docker](https://docs.docker.com/get-docker/)

```commandline

bun i

bun run

```

### Docker

```commandline

docker compose up

```