https://github.com/olegkorol/docker-tanstack-start
Deploy a TanStack Start React app everywhere Docker is supported, e.g. Fly.io.
https://github.com/olegkorol/docker-tanstack-start
docker flyio nitro tanstack tanstack-query tanstack-router tanstack-start tanstack-store
Last synced: 2 months ago
JSON representation
Deploy a TanStack Start React app everywhere Docker is supported, e.g. Fly.io.
- Host: GitHub
- URL: https://github.com/olegkorol/docker-tanstack-start
- Owner: olegkorol
- Created: 2025-02-27T10:32:58.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T13:43:14.000Z (2 months ago)
- Last Synced: 2025-02-27T19:26:44.622Z (2 months ago)
- Topics: docker, flyio, nitro, tanstack, tanstack-query, tanstack-router, tanstack-start, tanstack-store
- Language: TypeScript
- Homepage:
- Size: 366 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# TanStack (Start) with Docker
This is a simple example of a TanStack (Start) React app, initialized with `pnpm create tanstack-app@latest --add-ons`.
It includes a Docker configuration (with access to a writable directory) to build it and deploy it anywhere where Docker is supported.
There's also a simple configuration to quickly deploy it to Fly.io.
## Quickstart
To run this application:
```bash
pnpm install
pnpm dev
```
## Running with Docker
If you want to test the app locally before deploying to Fly.io (or elsewhere), you can run it in Docker:
```bash
docker build -t tanstack-react-app . && docker run -p 3000:3000 tanstack-react-app
```
The app will be available at `http://[::]:3000/`.
## Deploying to Fly.io
First, change your app details in the `fly.toml` file.
To deploy to Fly.io, you can use the following command:
```bash
fly deploy # the first time you might need to run `fly auth login` and `fly launch` first
```
## Building
To build this application for production:
```bash
pnpm run build
```
## Testing
This project uses [Vitest](https://vitest.dev/) for testing. You can run the tests with:
```bash
pnpm run test
```
## Styling
This project uses [Tailwind CSS](https://tailwindcss.com/) for styling.
## Shadcn
Add components using the canary version of [Shadcn](https://ui.shadcn.com/).
```bash
pnpx shadcn@canary add button
```
## Routing
This project uses [TanStack Router](https://tanstack.com/router). The initial setup is a file based router. Which means that the routes are managed as fiels in `src/routes`.
### Adding A Route
To add a new route to your application just add another a new file in the `./src/routes` directory.
TanStack will automatically generate the content of the route file for you.
Now that you have two routes you can use a `Link` component to navigate between them.
### Adding Links
To use SPA (Single Page Application) navigation you will need to import the `Link` component from `@tanstack/react-router`.
```tsx
import { Link } from "@tanstack/react-router";
```
Then anywhere in your JSX you can use it like so:
```tsx
About
```
This will create a link that will navigate to the `/about` route.
More information on the `Link` component can be found in the [Link documentation](https://tanstack.com/router/v1/docs/framework/react/api/router/linkComponent).
### Using A Layout
In the File Based Routing setup the layout is located in `src/routes/__root.tsx`. Anything you add to the root route will appear in all the routes. The route content will appear in the JSX where you use the `` component.
Here is an example layout that includes a header:
```tsx
import { createRootRoute, Outlet } from '@tanstack/react-router'
import { TanStackRouterDevtools } from '@tanstack/router-devtools'
import { Link } from "@tanstack/react-router";
export const Route = createRootRoute({
component: () => (
<>
Home
About
>
),
})
```
The `` component is not required so you can remove it if you don't want it in your layout.
More information on layouts can be found in the [Layouts documentation](hthttps://tanstack.com/router/latest/docs/framework/react/guide/routing-concepts#layouts).
## Data Fetching
There are multiple ways to fetch data in your application. You can use TanStack Query to fetch data from a server. But you can also use the `loader` functionality built into TanStack Router to load the data for a route before it's rendered.
For example:
```tsx
const peopleRoute = createRoute({
getParentRoute: () => rootRoute,
path: "/people",
loader: async () => {
const response = await fetch("https://swapi.dev/api/people");
return response.json() as Promise<{
results: {
name: string;
}[];
}>;
},
component: () => {
const data = peopleRoute.useLoaderData();
return (
- {person.name}
{data.results.map((person) => (
))}
);
},
});
```
Loaders simplify your data fetching logic dramatically. Check out more information in the [Loader documentation](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#loader-parameters).
### React-Query
React-Query is an excellent addition or alternative to route loading and integrating it into you application is a breeze.
First add your dependencies:
```bash
pnpm install @tanstack/react-query @tanstack/react-query-devtools
```
Next we'll need to creata query client and provider. We recommend putting those in `main.tsx`.
```tsx
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
// ...
const queryClient = new QueryClient();
// ...
if (!rootElement.innerHTML) {
const root = ReactDOM.createRoot(rootElement);
root.render(
);
}
```
You can also add TanStack Query Devtools to the root route (optional).
```tsx
import { ReactQueryDevtools } from "@tanstack/react-query-devtools";
const rootRoute = createRootRoute({
component: () => (
<>
>
),
});
```
Now you can use `useQuery` to fetch your data.
```tsx
import { useQuery } from "@tanstack/react-query";
import "./App.css";
function App() {
const { data } = useQuery({
queryKey: ["people"],
queryFn: () =>
fetch("https://swapi.dev/api/people")
.then((res) => res.json())
.then((data) => data.results as { name: string }[]),
initialData: [],
});
return (
- {person.name}
{data.map((person) => (
))}
);
}
export default App;
```
You can find out everything you need to know on how to use React-Query in the [React-Query documentation](https://tanstack.com/query/latest/docs/framework/react/overview).
## State Management
Another common requirement for React applications is state management. There are many options for state management in React. TanStack Store provides a great starting point for your project.
First you need to add TanStack Store as a dependency:
```bash
pnpm install @tanstack/store
```
Now let's create a simple counter in the `src/App.tsx` file as a demonstration.
```tsx
import { useStore } from "@tanstack/react-store";
import { Store } from "@tanstack/store";
import "./App.css";
const countStore = new Store(0);
function App() {
const count = useStore(countStore);
return (
countStore.setState((n) => n + 1)}>
Increment - {count}
);
}
export default App;
```
One of the many nice features of TanStack Store is the ability to derive state from other state. That derived state will update when the base state updates.
Let's check this out by doubling the count using derived state.
```tsx
import { useStore } from "@tanstack/react-store";
import { Store, Derived } from "@tanstack/store";
import "./App.css";
const countStore = new Store(0);
const doubledStore = new Derived({
fn: () => countStore.state * 2,
deps: [countStore],
});
doubledStore.mount();
function App() {
const count = useStore(countStore);
const doubledCount = useStore(doubledStore);
return (
countStore.setState((n) => n + 1)}>
Increment - {count}
);
}
export default App;
```
We use the `Derived` class to create a new store that is derived from another store. The `Derived` class has a `mount` method that will start the derived store updating.
Once we've created the derived store we can use it in the `App` component just like we would any other store using the `useStore` hook.
You can find out everything you need to know on how to use TanStack Store in the [TanStack Store documentation](https://tanstack.com/store/latest).
## Demo files
Files prefixed with `demo` can be safely deleted. They are there to provide a starting point for you to play around with the features you've installed.
## Learn More
You can learn more about all of the offerings from TanStack in the [TanStack documentation](https://tanstack.com).