Skip to content
Source
Sign inSign up
TanStack/config
Open History to see the last commit

overview.md

50 lines1.0 KB

1---
2id: overview
3title: Overview
4---
5​
6TanStack Config allows you to publish, update, and maintain your packages without having to provide complex configuration.
7​
8## Required Pre-Requisites
9​
10The following tools are required to use this package:
11​
12- [Node.js v18.17+](https://nodejs.org/en/download/current/)
13- [Git CLI](https://git-scm.com/downloads)
14- [GitHub CLI](https://cli.github.com/) (pre-installed on GitHub Actions)
15- [pnpm v8+](https://pnpm.io/)
16​
17> pnpm is the only supported package manager for TanStack Config.
18​
19## Installation
20​
21To install the package, run the following command:
22​
23```bash
24# AIO
25pnpm add -D @tanstack/config
26​
27# ESLint
28pnpm add -D @tanstack/eslint-config
29​
30# Publish
31pnpm add -D @tanstack/publish-config
32​
33# Typedoc
34pnpm add -D @tanstack/typedoc-config
35​
36# Vite
37pnpm add -D @tanstack/vite-config
38```
39​
40## Utilities
41​
42- [ESLint](../eslint.md)
43- [Publish](../publish.md)
44- [Vite](../vite.md)
45​
46## Conventions
47​
48- [CI/CD](../ci-cd.md)
49- [Dependencies](../dependencies.md)
50- [Package Structure](../package-structure.md)