Skip to content

Commit 784f7bc

Browse files
committed
docs: fix server/server.ts name
1 parent 72d325a commit 784f7bc

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

docs/docs/development/llm-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Examples of known paths:
7070

7171
- `package.json` has `"type": "module"`
7272
- `tsx` is in devDependencies for dev server
73-
- `dev` script uses `NODE_ENV=development tsx watch server/index.ts`
73+
- `dev` script uses `NODE_ENV=development tsx watch server/server.ts`
7474
- `client/index.html` exists with `<div id="root"></div>` and script pointing to `client/src/main.tsx`
7575

7676
### Backend

docs/docs/development/project-setup.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Recommended structure (client/server split):
1313
```
1414
my-app/
1515
├── server/
16-
│ ├── index.ts # backend entry point (AppKit)
16+
│ ├── server.ts # backend entry point (AppKit)
1717
│ └── .env # optional local dev env vars (do not commit)
1818
├── client/
1919
│ ├── index.html
@@ -46,9 +46,9 @@ The AppKit `server()` plugin automatically serves:
4646
"version": "0.0.0",
4747
"type": "module",
4848
"scripts": {
49-
"dev": "NODE_ENV=development tsx watch server/index.ts",
49+
"dev": "NODE_ENV=development tsx watch server/server.ts",
5050
"build": "npm run build:server && npm run build:client",
51-
"build:server": "tsdown --out-dir build server/index.ts",
51+
"build:server": "tsdown --out-dir build server/server.ts",
5252
"build:client": "tsc -b && vite build --config client/vite.config.ts",
5353
"start": "node build/index.mjs"
5454
},
@@ -145,7 +145,7 @@ export default defineConfig({
145145
}
146146
```
147147

148-
### `server/index.ts`
148+
### `server/server.ts`
149149

150150
```ts
151151
import { createApp, server } from "@databricks/appkit";
@@ -185,7 +185,7 @@ If you don't already have a `client/` folder, create one and move your Vite app
185185
- Move `vite.config.ts``client/vite.config.ts`
186186
- Move `src/``client/src/`
187187

188-
### 2. Create `server/index.ts` (New File)
188+
### 2. Create `server/server.ts` (New File)
189189

190190
```ts
191191
import { createApp, server } from "@databricks/appkit";
@@ -200,9 +200,9 @@ await createApp({
200200
```json
201201
{
202202
"scripts": {
203-
"dev": "NODE_ENV=development tsx watch server/index.ts",
203+
"dev": "NODE_ENV=development tsx watch server/server.ts",
204204
"build": "npm run build:server && npm run build:client",
205-
"build:server": "tsdown --out-dir build server/index.ts",
205+
"build:server": "tsdown --out-dir build server/server.ts",
206206
"build:client": "tsc -b && vite build --config client/vite.config.ts",
207207
"start": "node build/index.mjs"
208208
}
@@ -218,7 +218,7 @@ AppKit's server plugin will automatically serve your Vite app in dev mode and `c
218218
To add SQL query execution capabilities:
219219

220220
```ts
221-
// server/index.ts
221+
// server/server.ts
222222
import { createApp, server, analytics } from "@databricks/appkit";
223223

224224
await createApp({

docs/docs/development/type-generation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,5 +104,5 @@ data?.forEach(row => {
104104

105105
## See also
106106

107-
- [Plugins](../plugins/index.md) - Analytics plugin configuration
107+
- [Plugins](../plugins/analytics.md) - Analytics plugin configuration
108108
- [API Reference](/docs/api/appkit-ui) - Complete UI components API documentation

docs/docs/plugins/server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Server plugin uses the deferred initialization phase to access routes from o
2828
The smallest valid AppKit server:
2929

3030
```ts
31-
// server/index.ts
31+
// server/server.ts
3232
import { createApp, server } from "@databricks/appkit";
3333

3434
await createApp({

0 commit comments

Comments
 (0)