tanstack 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +115 -0
- package/bin/create-tanstack-app.js +0 -0
- package/package.json +6 -2
package/README.md
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# TanStack App Creator
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/js/tanstack)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
6
|
+
🚀 A powerful CLI tool for scaffolding TanStack applications with best practices and optimal configurations.
|
|
7
|
+
|
|
8
|
+
## Quick Start
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npx create-tanstack-app my-app
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Features
|
|
15
|
+
|
|
16
|
+
- 🎯 **Easy to use** - Simple one-command setup
|
|
17
|
+
- ⚡ **Modern tooling** - Built with latest TanStack libraries
|
|
18
|
+
- 📦 **Zero dependencies** - Lightweight and fast
|
|
19
|
+
- 🔧 **Configurable** - Customizable templates and options
|
|
20
|
+
- 📚 **Well documented** - Comprehensive guides and examples
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
23
|
+
|
|
24
|
+
### Using npx (Recommended)
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx create-tanstack-app my-awesome-app
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Global Installation
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm install -g tanstack
|
|
34
|
+
create-tanstack-app my-awesome-app
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## What is TanStack?
|
|
38
|
+
|
|
39
|
+
TanStack is a collection of high-quality, performant libraries for building modern web applications:
|
|
40
|
+
|
|
41
|
+
- **[TanStack Query](https://tanstack.com/query)** - Powerful data synchronization for TS/JS
|
|
42
|
+
- **[TanStack Router](https://tanstack.com/router)** - Type-safe router for React
|
|
43
|
+
- **[TanStack Table](https://tanstack.com/table)** - Headless UI for building tables
|
|
44
|
+
- **[TanStack Virtual](https://tanstack.com/virtual)** - Virtualization for large datasets
|
|
45
|
+
|
|
46
|
+
## Usage
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# Create a new TanStack app
|
|
50
|
+
npx create-tanstack-app my-app
|
|
51
|
+
|
|
52
|
+
# Navigate to your project
|
|
53
|
+
cd my-app
|
|
54
|
+
|
|
55
|
+
# Start development
|
|
56
|
+
npm run dev
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Templates (Coming Soon)
|
|
60
|
+
|
|
61
|
+
- 🔥 **React + TanStack Query** - Data fetching made easy
|
|
62
|
+
- 🌐 **React + TanStack Router** - Type-safe routing
|
|
63
|
+
- 📊 **React + TanStack Table** - Powerful data tables
|
|
64
|
+
- ⚡ **Next.js + TanStack** - Full-stack React framework
|
|
65
|
+
- 📱 **Vite + TanStack** - Lightning-fast development
|
|
66
|
+
|
|
67
|
+
## Requirements
|
|
68
|
+
|
|
69
|
+
- Node.js 14.0.0 or higher
|
|
70
|
+
- npm or yarn
|
|
71
|
+
|
|
72
|
+
## Contributing
|
|
73
|
+
|
|
74
|
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
75
|
+
|
|
76
|
+
1. Fork the repository
|
|
77
|
+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
|
78
|
+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
|
79
|
+
4. Push to the branch (`git push origin feature/amazing-feature`)
|
|
80
|
+
5. Open a Pull Request
|
|
81
|
+
|
|
82
|
+
## License
|
|
83
|
+
|
|
84
|
+
MIT License - see the [LICENSE](LICENSE) file for details.
|
|
85
|
+
|
|
86
|
+
## Author
|
|
87
|
+
|
|
88
|
+
**sh20raj**
|
|
89
|
+
|
|
90
|
+
- 🐦 Twitter/X: [@sh20raj](https://x.com/sh20raj)
|
|
91
|
+
- 🐙 GitHub: [@sh20raj](https://github.com/sh20raj)
|
|
92
|
+
|
|
93
|
+
## Support
|
|
94
|
+
|
|
95
|
+
- ⭐ Star this repo if you find it useful!
|
|
96
|
+
- 🐛 [Report bugs](https://github.com/sh20raj/tanstack/issues)
|
|
97
|
+
- 💡 [Request features](https://github.com/sh20raj/tanstack/issues)
|
|
98
|
+
|
|
99
|
+
## Roadmap
|
|
100
|
+
|
|
101
|
+
- [ ] React + TanStack Query template
|
|
102
|
+
- [ ] React + TanStack Router template
|
|
103
|
+
- [ ] Next.js integration
|
|
104
|
+
- [ ] TypeScript support
|
|
105
|
+
- [ ] Multiple UI framework support
|
|
106
|
+
- [ ] Custom template system
|
|
107
|
+
- [ ] Interactive CLI prompts
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
<div align="center">
|
|
112
|
+
<strong>Happy coding! 🎯</strong>
|
|
113
|
+
<br>
|
|
114
|
+
<em>Built with ❤️ by <a href="https://github.com/sh20raj">sh20raj</a></em>
|
|
115
|
+
</div>
|
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tanstack",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "A CLI tool to create TanStack applications",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
7
|
-
"create-tanstack-app": "./bin/create-tanstack-app.js"
|
|
7
|
+
"create-tanstack-app": "./bin/create-tanstack-app.js",
|
|
8
|
+
"tanstack": "./bin/create-tanstack-app.js"
|
|
8
9
|
},
|
|
9
10
|
"scripts": {
|
|
10
11
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
@@ -27,5 +28,8 @@
|
|
|
27
28
|
"homepage": "https://github.com/sh20raj/tanstack",
|
|
28
29
|
"bugs": {
|
|
29
30
|
"url": "https://github.com/sh20raj/tanstack/issues"
|
|
31
|
+
},
|
|
32
|
+
"dependencies": {
|
|
33
|
+
"tanstack": "^1.0.1"
|
|
30
34
|
}
|
|
31
35
|
}
|