Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/liblaf/copier-typescript

๐Ÿ› ๏ธ TypeScript project template with CI/CD and linting setup
https://github.com/liblaf/copier-typescript

cli code-quality continuous-integration copier-template github-api nodejs npm package-manager repository-automation typescript workflow

Last synced: about 5 hours ago
JSON representation

๐Ÿ› ๏ธ TypeScript project template with CI/CD and linting setup

Awesome Lists containing this project

README

        




Copier TypeScript

This repository provides a robust TypeScript project template with automated workflows for CI/CD, dependency management, and code quality assurance. It features comprehensive configuration for modern development tools including Biome, tsup, and GitHub Actions, ensuring high-quality code and streamlined package publishing.

[![Made with Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-black.json)](https://github.com/copier-org/copier)

[![GitHub contributors](https://img.shields.io/github/contributors/liblaf/copier-typescript)](https://github.com/liblaf/copier-typescript/graphs/contributors)
[![GitHub forks](https://img.shields.io/github/forks/liblaf/copier-typescript)](https://github.com/liblaf/copier-typescript/forks)
[![GitHub Repo stars](https://img.shields.io/github/stars/liblaf/copier-typescript)](https://github.com/liblaf/copier-typescript/stargazers)
[![GitHub Issues](https://img.shields.io/github/issues/liblaf/copier-typescript)](https://github.com/liblaf/copier-typescript/issues)
[![GitHub License](https://img.shields.io/github/license/liblaf/copier-typescript)](https://github.com/liblaf/copier-typescript/blob/main/LICENSE)

[Changelog](./CHANGELOG.md) ยท [Report Bug](https://github.com/liblaf/copier-typescript/issues) ยท [Request Feature](https://github.com/liblaf/copier-typescript/issues)

![banner](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)

## โœจ Features

- ๐Ÿค– **Automated Workflows:** The repository includes GitHub Actions workflows for automated PR management, repository maintenance, and CI/CD processes, ensuring smooth and efficient development cycles;
- ๐Ÿ› ๏ธ **Template-Based Setup:** Utilizes Copier templates for easy project initialization and updates, making it simple to maintain consistency across multiple projects;
- ๐Ÿ“ฆ **Package Management:** Includes a `package.json` template with pre-configured scripts for building, linting, and packaging, streamlining the development process;
- ๐Ÿงน **Code Quality Assurance:** Integrates MegaLinter for comprehensive code quality checks, ensuring high standards of code hygiene and consistency;
- ๐Ÿ”„ **Renovate Integration:** Automates dependency updates with Renovate, keeping the project dependencies up-to-date and secure;
- ๐Ÿ“œ **License Management:** Provides a default MIT license template, making it easy to manage legal aspects of the project;
- ๐Ÿš€ **Release Automation:** Includes workflows for automated pre-releases and releases, simplifying the process of publishing new versions;
- ๐Ÿงฉ **Modular Configuration:** Offers a modular and configurable setup with `tsup` for building TypeScript projects, supporting both CommonJS and ES modules;
- ๐Ÿ“‚ **Structured Directory Layout:** Follows a well-organized directory structure, making it easy to navigate and manage the project files;
- ๐Ÿ”ง **VS Code Integration:** Includes pre-configured VS Code settings for a seamless development experience, with support for excluding unnecessary files like `node_modules`.

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

## ๐Ÿ“ฆ Installation

To install `gh:liblaf/copier-typescript`, run the following command:

```bash
$ copier copy --trust gh:liblaf/copier-typescript .
```

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

## โŒจ๏ธ Local Development

You can use Github Codespaces for online development:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/liblaf/copier-typescript)

Or clone it for local development:

```bash
$ git clone https://github.com/liblaf/copier-typescript.git
$ cd copier-typescript
```

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

## ๐Ÿค Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/liblaf/copier-typescript/issues) to get stuck in to show us what you're made of.

[![๐Ÿคฏ PR WELCOME](https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/liblaf/copier-typescript/pulls)

[![Contributors](https://contrib.rocks/image?repo=liblaf%2Fcopier-typescript)](https://github.com/liblaf/copier-typescript/graphs/contributors)

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

## ๐Ÿ”— Links

### More Copier Templates

- **[Copier Python](https://github.com/liblaf/copier-python)** - ๐Ÿš€ A comprehensive Python project template with automated workflows, CI/CD integration, and modern development tools. Features include MegaLinter for code quality, Copier for template updates, and Renovate for dependency management. Perfect for building scalable Python packages with best practices! ๐Ÿโœจ
- **[Copier Release](https://github.com/liblaf/copier-release)** - ๐Ÿš€ Automated GitHub Repository Management Toolkit: A comprehensive set of workflows and templates for automating repository maintenance, PR management, and release processes. Includes Copier updates, MegaLinter integration, and Release Please automation. Perfect for maintaining clean, consistent, and efficient GitHub repositories! ๐Ÿ› ๏ธโœจ
- **[Copier Share](https://github.com/liblaf/copier-share)** - ๐Ÿค–โœจ A comprehensive GitHub repository template with automated workflows for PR management, repository maintenance, and code quality checks. Features include auto-merging PRs, Copier updates, label synchronization, and MegaLinter integration for consistent code standards. Perfect for maintaining clean, efficient, and well-organized repositories! ๐Ÿš€๐Ÿ”ง
- **[Copier Typescript](https://github.com/liblaf/copier-typescript)** - ๐Ÿš€ A robust TypeScript project template with automated workflows, CI/CD pipelines, and comprehensive linting. Features include auto-PR management, copier updates, and MegaLinter integration for code quality. Perfect for scalable, maintainable, and efficient TypeScript projects! ๐Ÿ› ๏ธโœจ

### Credits

- **copier** -

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

---

#### ๐Ÿ“ License

Copyright ยฉ 2024 [liblaf](https://github.com/liblaf).

This project is [MIT](https://github.com/liblaf/copier-typescript/blob/main/LICENSE) licensed.