Skip to content

Commit 781a557

Browse files
committed
docs(server): clarify canonical mock server location (server/server)
1 parent f2d272a commit 781a557

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

server/README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
# App Scripting Server (dev mock)
22

3-
Simple TypeScript + Express mock server used for local development by the editor.
3+
Note: this top-level `server/` folder contains helper files and a copy of the mock server for historical reasons. The canonical server project used by CI and for local development is `server/server`.
44

5-
Endpoints:
6-
- GET /health — basic health check
7-
- GET /me — returns a mock authenticated profile
8-
- POST /logout — mock logout endpoint
9-
10-
Run (from repo root):
5+
To run or develop the mock server, use the inner folder (recommended):
116

127
```powershell
13-
cd server
8+
cd server/server
149
npm install
1510
npm run dev
1611
```
12+
13+
If you intend to make changes to the mock server, edit files under `server/server` so CI (which builds `./server/server`) and local dev remain consistent.

server/server/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
Editor mock server for local development
1+
Editor mock server for local development (canonical server for this repo)
22

33
Run:
44

55
```powershell
6-
cd editor/server
6+
cd server/server
77
npm install
88
npm run dev
99
```

0 commit comments

Comments
 (0)