Skip to content

Commit 401883c

Browse files
authored
Add Appwrite Sites to TanStack Start hosting docs (#5746)
1 parent f96697a commit 401883c

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

docs/start/framework/react/guide/hosting.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Once you've chosen a deployment target, you can follow the deployment guidelines
2525
- [`railway`](#nodejs--railway--docker): Deploy to Railway
2626
- [`node-server`](#nodejs--railway--docker): Deploy to a Node.js server
2727
- [`bun`](#bun): Deploy to a Bun server
28+
- [`appwrite-sites`](#appwrite-sites): Deploy to Appwrite Sites
2829
- ... and more to come!
2930

3031
### Cloudflare Workers ⭐ _Official Partner_
@@ -369,3 +370,36 @@ bun run server.ts
369370
```
370371

371372
For a complete working example, check out the [TanStack Start + Bun example](https://github.com/TanStack/router/tree/main/examples/react/start-bun) in this repository.
373+
374+
### Appwrite Sites
375+
376+
When deploying to [Appwrite Sites](https://appwrite.io/products/sites), you'll need to complete a few steps:
377+
378+
1. **Create a TanStack Start app** (or use an existing one)
379+
380+
```bash
381+
npm create @tanstack/start@latest
382+
```
383+
384+
2. **Push your project to a GitHub repository**
385+
386+
Create a [GitHub repository](https://github.com/new) and push your code.
387+
388+
3. **Create an Appwrite project**
389+
390+
Head to [Appwrite Cloud](https://cloud.appwrite.io) and sign up if you haven't already, then create your first project.
391+
392+
4. **Deploy your site**
393+
394+
In your Appwrite project, navigate to the **Sites** page from the sidebar. Click on the **Create site**, select **Connect a repository**, connect your GitHub account and select your repository.
395+
396+
1. Select the **production branch** and **root directory**
397+
2. Verify **TanStack Start** is selected as the framework
398+
3. Confirm the build settings:
399+
- **Install command:** `npm install`
400+
- **Build command:** `npm run build`
401+
- **Output directory:** `./dist` (if you're using Nitro v2 or v3, this should be `./.output`)
402+
4. Add any required **environment variables**
403+
5. Click **Deploy**
404+
405+
After successful deployment, click the **Visit site** button to see your deployed application.

docs/start/framework/solid/guide/hosting.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Once you've chosen a deployment target, you can follow the deployment guidelines
2525
- [`railway`](#nodejs--railway--docker): Deploy to Railway
2626
- [`node-server`](#nodejs--railway--docker): Deploy to a Node.js server
2727
- [`bun`](#bun): Deploy to a Bun server
28+
- [`appwrite-sites`](#appwrite-sites): Deploy to Appwrite Sites
2829
- ... and more to come!
2930

3031
### Cloudflare Workers ⭐ _Official Partner_
@@ -252,3 +253,36 @@ export default defineConfig({
252253
],
253254
})
254255
```
256+
257+
### Appwrite Sites
258+
259+
When deploying to [Appwrite Sites](https://appwrite.io/products/sites), you'll need to complete a few steps:
260+
261+
1. **Create a TanStack Start app** (or use an existing one)
262+
263+
```bash
264+
npm create @tanstack/start@latest
265+
```
266+
267+
2. **Push your project to a GitHub repository**
268+
269+
Create a [GitHub repository](https://github.com/new) and push your code.
270+
271+
3. **Create an Appwrite project**
272+
273+
Head to [Appwrite Cloud](https://cloud.appwrite.io) and sign up if you haven't already, then create your first project.
274+
275+
4. **Deploy your site**
276+
277+
In your Appwrite project, navigate to the **Sites** page from the sidebar. Click on the **Create site**, select **Connect a repository**, connect your GitHub account and select your repository.
278+
279+
1. Select the **production branch** and **root directory**
280+
2. Verify **TanStack Start** is selected as the framework
281+
3. Confirm the build settings:
282+
- **Install command:** `npm install`
283+
- **Build command:** `npm run build`
284+
- **Output directory:** `./dist` (if you're using Nitro v2 or v3, this should be `./.output`)
285+
4. Add any required **environment variables**
286+
5. Click **Deploy**
287+
288+
After successful deployment, click the **Visit site** button to see your deployed application.

0 commit comments

Comments
 (0)