Skip to content
View boyhax's full-sized avatar
🎯
Focusing
🎯
Focusing

Block or report boyhax

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Maximum 250 characters. Please don’t include any personal information such as legal names or email addresses. Markdown is supported. This note will only be visible to you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
boyhax/README.md

Welcome to your new TanStack Start app!

Getting Started

To run this application:

npm install
npm run dev

Building For Production

To build this application for production:

npm run build

Testing

This project uses Vitest for testing. You can run the tests with:

npm run test

Styling

This project uses Tailwind CSS for styling.

Removing Tailwind CSS

If you prefer not to use Tailwind CSS:

  1. Remove the demo pages in src/routes/demo/
  2. Replace the Tailwind import in src/styles.css with your own styles
  3. Remove tailwindcss() from the plugins array in vite.config.ts
  4. Uninstall the packages: npm install @tailwindcss/vite tailwindcss -D

Deploy with Nitro

This project uses Nitro as a generic server adapter, so it can run on any Node-compatible host.

npm run build
node dist/server/index.mjs

The build output is a self-contained Node server. To deploy, push the dist/ directory to your host (Render, Fly.io, your own VPS, etc.) and run the server command above.

For host-specific presets (Vercel, Netlify, Cloudflare, AWS Lambda, etc.) and tuning, see https://v3.nitro.build/deploy.

Resume Example

A professional resume template built with TanStack Start and content-collections for Netlify deployment.

Features

  • Content Collections: Work experience and education managed as markdown files
  • Skills Filter: Interactive sidebar to filter jobs by skills/technologies
  • Beautiful UI: Modern design with shadcn/ui components
  • SSR Ready: Full server-side rendering with TanStack Start

Project Structure

├── content/
│   ├── jobs/              # Work experience entries
│   └── education/         # Education entries
├── src/
│   ├── components/
│   │   └── ui/            # Shadcn UI components
│   │       ├── badge.tsx
│   │       ├── card.tsx
│   │       ├── checkbox.tsx
│   │       ├── hover-card.tsx
│   │       └── separator.tsx
│   ├── lib/
│   │   └── utils.ts       # Utility functions
│   └── routes/
│       ├── __root.tsx     # Root layout
│       └── index.tsx      # Resume page
└── public/
    └── headshot-on-white.jpg

Adding Work Experience

Create a new markdown file in content/jobs/ with the following frontmatter:

---
jobTitle: Your Job Title
company: Company Name
location: City, State
startDate: 2024-01-01
endDate: 2024-12-31  # Optional - omit for current position
summary: Brief summary of your role
tags:
  - React
  - TypeScript
  - Web Development
---

Detailed description of your responsibilities and achievements...

Adding Education

Create a new markdown file in content/education/:

---
school: School Name
summary: Degree or Program Name
startDate: 2020-01-01
endDate: 2024-01-01
tags:
  - Relevant
  - Skills
---

Details about your education...

Development

# Start development server
npm run dev

# Build for production
npm run build

Routing

This project uses TanStack Router with file-based routing. Routes are managed as files in src/routes.

Adding A Route

To add a new route to your application just add 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.

import { Link } from "@tanstack/react-router";

Then anywhere in your JSX you can use it like so:

<Link to="/about">About</Link>

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.

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 render {children} in the shellComponent.

Here is an example layout that includes a header:

import { HeadContent, Scripts, createRootRoute } from '@tanstack/react-router'

export const Route = createRootRoute({
  head: () => ({
    meta: [
      { charSet: 'utf-8' },
      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
      { title: 'My App' },
    ],
  }),
  shellComponent: ({ children }) => (
    <html lang="en">
      <head>
        <HeadContent />
      </head>
      <body>
        <header>
          <nav>
            <Link to="/">Home</Link>
            <Link to="/about">About</Link>
          </nav>
        </header>
        {children}
        <Scripts />
      </body>
    </html>
  ),
})

More information on layouts can be found in the Layouts documentation.

Server Functions

TanStack Start provides server functions that allow you to write server-side code that seamlessly integrates with your client components.

import { createServerFn } from '@tanstack/react-start'

const getServerTime = createServerFn({
  method: 'GET',
}).handler(async () => {
  return new Date().toISOString()
})

// Use in a component
function MyComponent() {
  const [time, setTime] = useState('')
  
  useEffect(() => {
    getServerTime().then(setTime)
  }, [])
  
  return <div>Server time: {time}</div>
}

API Routes

You can create API routes by using the server property in your route definitions:

import { createFileRoute } from '@tanstack/react-router'
import { json } from '@tanstack/react-start'

export const Route = createFileRoute('/api/hello')({
  server: {
    handlers: {
      GET: () => json({ message: 'Hello, World!' }),
    },
  },
})

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:

import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/people')({
  loader: async () => {
    const response = await fetch('https://swapi.dev/api/people')
    return response.json()
  },
  component: PeopleComponent,
})

function PeopleComponent() {
  const data = Route.useLoaderData()
  return (
    <ul>
      {data.results.map((person) => (
        <li key={person.name}>{person.name}</li>
      ))}
    </ul>
  )
}

Loaders simplify your data fetching logic dramatically. Check out more information in the Loader documentation.

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.

For TanStack Start specific documentation, visit TanStack Start.

Popular repositories Loading

  1. manazl.site manazl.site Public

    TypeScript 3 1

  2. OmanStatesAndCities OmanStatesAndCities Public

    TypeScript 2

  3. godot godot Public

    Forked from godotengine/godot

    Godot Engine – Multi-platform 2D and 3D game engine

    C++

  4. ShoflyTawseel-ionic-react-firebase-delivery-app ShoflyTawseel-ionic-react-firebase-delivery-app Public template

    TypeScript

  5. tutorial-photo-gallery-react tutorial-photo-gallery-react Public

    Forked from ionic-team/tutorial-photo-gallery-react

    Photo Gallery Tutorial: Ionic React and Capacitor

    TypeScript

  6. shift-days shift-days Public

    TypeScript