KoCoder
6d6dcb66a1
All checks were successful
Build and Push Docker Image / build (push) Successful in 3m6s
163 lines
4.4 KiB
Markdown
163 lines
4.4 KiB
Markdown
Welcome to your new TanStack Start app!
|
|
|
|
# Getting Started
|
|
|
|
To run this application:
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
# Building For Production
|
|
|
|
To build this application for production:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## Styling
|
|
|
|
This project uses [Tailwind CSS](https://tailwindcss.com/) 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.
|
|
|
|
```bash
|
|
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.
|
|
|
|
|
|
## Solid-UI
|
|
|
|
This installation of Solid-UI follows the manual instructions but was modified to work with Tailwind V4.
|
|
|
|
To install the components, run the following command (this install button):
|
|
|
|
```bash
|
|
npx -y solidui-cli@latest add button
|
|
```
|
|
|
|
|
|
|
|
## Routing
|
|
|
|
This project uses [TanStack Router](https://tanstack.com/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/solid-router`.
|
|
|
|
```tsx
|
|
import { Link } from "@tanstack/solid-router";
|
|
```
|
|
|
|
Then anywhere in your JSX you can use it like so:
|
|
|
|
```tsx
|
|
<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](https://tanstack.com/router/v1/docs/framework/solid/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.
|
|
|
|
More information on layouts can be found in the [Layouts documentation](https://tanstack.com/router/latest/docs/framework/solid/guide/routing-concepts#layouts).
|
|
|
|
## Server Functions
|
|
|
|
TanStack Start provides server functions that allow you to write server-side code that seamlessly integrates with your client components.
|
|
|
|
```tsx
|
|
import { createServerFn } from '@tanstack/solid-start'
|
|
|
|
const getServerTime = createServerFn({
|
|
method: 'GET',
|
|
}).handler(async () => {
|
|
return new Date().toISOString()
|
|
})
|
|
```
|
|
|
|
## 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
|
|
import { createFileRoute } from '@tanstack/solid-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>
|
|
<For each={data().results}>
|
|
{(person) => <li>{person.name}</li>}
|
|
</For>
|
|
</ul>
|
|
)
|
|
}
|
|
```
|
|
|
|
Loaders simplify your data fetching logic dramatically. Check out more information in the [Loader documentation](https://tanstack.com/router/latest/docs/framework/solid/guide/data-loading#loader-parameters).
|
|
|
|
# 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.
|
|
|
|
|
|
## Linting & Formatting
|
|
|
|
This project uses [Biome](https://biomejs.dev/) for linting and formatting. The following scripts are available:
|
|
|
|
|
|
```bash
|
|
npm run lint
|
|
npm run format
|
|
npm run check
|
|
```
|
|
|
|
|
|
# Learn More
|
|
|
|
You can learn more about all of the offerings from TanStack in the [TanStack documentation](https://tanstack.com).
|
|
|
|
For TanStack Start specific documentation, visit [TanStack Start](https://tanstack.com/start).
|