tanstack/README.md

A CLI tool to create TanStack applications

# TanStack App Creator

[![npm version](https://badge.fury.io/js/tanstack.svg)](https://badge.fury.io/js/tanstack)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

🚀 A powerful CLI tool for scaffolding TanStack applications with best practices and optimal configurations.

## Quick Start

```bash
npx create-tanstack-app my-app
```

## Features

- 🎯 **Easy to use** - Simple one-command setup
- ⚡ **Modern tooling** - Built with latest TanStack libraries
- 📦 **Zero dependencies** - Lightweight and fast
- 🔧 **Configurable** - Customizable templates and options
- 📚 **Well documented** - Comprehensive guides and examples

## Installation

### Using npx (Recommended)

```bash
npx create-tanstack-app my-awesome-app
```

### Global Installation

```bash
npm install -g tanstack
create-tanstack-app my-awesome-app
```

## What is TanStack?

TanStack is a collection of high-quality, performant libraries for building modern web applications:

- **[TanStack Query](https://tanstack.com/query)** - Powerful data synchronization for TS/JS
- **[TanStack Router](https://tanstack.com/router)** - Type-safe router for React
- **[TanStack Table](https://tanstack.com/table)** - Headless UI for building tables
- **[TanStack Virtual](https://tanstack.com/virtual)** - Virtualization for large datasets

## Usage

```bash
# Create a new TanStack app
npx create-tanstack-app my-app

# Navigate to your project
cd my-app

# Start development
npm run dev
```

## Templates (Coming Soon)

- 🔥 **React + TanStack Query** - Data fetching made easy
- 🌐 **React + TanStack Router** - Type-safe routing
- 📊 **React + TanStack Table** - Powerful data tables
- ⚡ **Next.js + TanStack** - Full-stack React framework
- 📱 **Vite + TanStack** - Lightning-fast development

## Requirements

- Node.js 14.0.0 or higher
- npm or yarn

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

MIT License - see the [LICENSE](LICENSE) file for details.

## Author

**sh20raj**

- 🐦 Twitter/X: [@sh20raj](https://x.com/sh20raj)
- 🐙 GitHub: [@sh20raj](https://github.com/sh20raj)

## Support

- ⭐ Star this repo if you find it useful!
- 🐛 [Report bugs](https://github.com/sh20raj/tanstack/issues)
- 💡 [Request features](https://github.com/sh20raj/tanstack/issues)

## Roadmap

- [ ] React + TanStack Query template
- [ ] React + TanStack Router template  
- [ ] Next.js integration
- [ ] TypeScript support
- [ ] Multiple UI framework support
- [ ] Custom template system
- [ ] Interactive CLI prompts

---

<div align="center">
  <strong>Happy coding! 🎯</strong>
  <br>
  <em>Built with ❤️ by <a href="https://github.com/sh20raj">sh20raj</a></em>
</div>