Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.28 KB

README.md

File metadata and controls

74 lines (49 loc) · 2.28 KB
Raw

TanStack Starter Template

This is a simple starter template for a project using TanStack Start. It demonstrates how to quickly scaffold a project, set up routes, and manage application state efficiently.

Features

  • Loader Data: Fetch and display data using TanStack's route loader.
  • Dynamic Updates: Modify state and refresh loader data using router.invalidate().
  • Styled UI: Includes a basic layout with responsive styles.

Getting Started

To start using this template, run the following command:

npx create-tanstack-app@latest --template tanstack-router

Follow the prompts to set up your project. The generated files include basic starter functionality from TanStack, so you can build on top of them or replace specific components with the code in this repository as needed.

Prerequisites

Ensure you have the following installed:

Installation

  1. Clone the repository or use the starter command above to create a new app.
  2. Navigate to the project directory: 
    cd your-project-name
  3. Install dependencies: 
    npm install

Running the App

Start the development server:

npm run dev

Visit http://localhost:3000 to view your application.

Project Structure

src/
├── components/         # Reusable UI components
├── routes/             # Application routes
├── styles/             # Global and component-specific styles
├── utils/              # Utility functions and helpers
└── main.jsx            # Entry point for the React application

Customization

  • Modify the getCount and updateCount functions in src/functions/ to connect to your backend or API. Refer to the examples and guidelines provided on the TanStack Start page for best practices when integrating these functions.
  • Add additional routes in src/routes/ as your application grows.

Learn More

License

This project is licensed under the MIT License.