https://github.com/loaderb0t/typescript-starter

A template repo for new typescript projects
https://github.com/loaderb0t/typescript-starter

Last synced: about 1 year ago
JSON representation

A template repo for new typescript projects

• Host: GitHub
• URL: https://github.com/loaderb0t/typescript-starter
• Owner: LoaderB0T
• License: mit
• Created: 2023-11-04T22:45:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-03T14:01:47.000Z (over 1 year ago)
• Last Synced: 2025-03-03T14:33:40.776Z (over 1 year ago)
• Language: TypeScript
• Size: 1.37 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![npm](https://img.shields.io/npm/v/typescript-starter?color=%2300d26a&style=for-the-badge)](https://www.npmjs.com/package/typescript-starter)

[![Build Status](https://img.shields.io/github/actions/workflow/status/LoaderB0T/typescript-starter/build.yml?branch=main&style=for-the-badge)](https://github.com/LoaderB0T/typescript-starter/actions/workflows/build.yml)

[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/LoaderB0T_typescript-starter?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/summary/new_code?id=LoaderB0T_typescript-starter)

[![bundle size](https://img.shields.io/bundlephobia/minzip/typescript-starter?color=%23FF006F&label=Bundle%20Size&style=for-the-badge)](https://bundlephobia.com/package/typescript-starter)

# typescript-starter

Template for TypeScript projects with Jest, ESLint, Prettier, GitHub Actions, and more.

## Motivation 💥

**typescript-starter** is a template for TypeScript (ESM&CJS) projects with Jest, ESLint, Prettier, GitHub Actions, and more.

## Features 🔥

✅ Put features here

✅ Add more features here

✅ Add even more features here

✅ How about some more features?

✅ Ok, last one

## Built With 🔧

- [TypeScript](https://www.typescriptlang.org/)

## Installation 📦

```console

pnpm i typescript-starter

// or

yarn add typescript-starter

// or

npm i typescript-starter

```

## Docs 📃

Find a bit of documentation [here](https://github.com/LoaderB0T/typescript-starter/blob/main/DOCS.md).

## Usage Example 🚀

```typescript

import { Something } from 'typescript-starter';

```

```typescript

// Example: Simple text logging

Something.dostuff('Welcome to typescript-starter!');

```

## Contributing 🧑🏻‍💻

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## License 🔑

Distributed under the MIT License. See `LICENSE.txt` for more information.

## Contact 📧

Janik Schumacher - [@LoaderB0T](https://twitter.com/LoaderB0T) - [linkedin](https://www.linkedin.com/in/janikschumacher/)

Project Link: [https://github.com/LoaderB0T/typescript-starter](https://github.com/LoaderB0T/typescript-starter)