Skip to content

Commit c86e416

Browse files
CopilotGizzZmo
andcommitted
docs: update README and contributing guidance
Co-authored-by: GizzZmo <8039975+GizzZmo@users.noreply.github.com>
1 parent 62b6169 commit c86e416

File tree

2 files changed

+21
-10
lines changed

2 files changed

+21
-10
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Thank you for your interest in contributing! Here are some guidelines to help yo
1919

2020
## Build, Lint, and Test
2121

22+
- Use Node.js 20.x (npm 10.x) to match CI.
2223
- Install dependencies with `npm run install:all`.
2324
- Build shared types first: `npx tsc --build src/types`.
2425
- Run the full build: `npm run build:all`.

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ This project is structured as a monorepo containing both a frontend (React/TypeS
119119

120120
### Prerequisites
121121

122-
- Node.js (v16 or higher)
123-
- npm (v7 or higher)
122+
- Node.js 20.x
123+
- npm 10.x (bundled with Node.js 20)
124124

125125
### Installation
126126

@@ -132,15 +132,9 @@ This project is structured as a monorepo containing both a frontend (React/TypeS
132132

133133
2. **Install dependencies:**
134134
```bash
135-
# Install root dependencies
136-
npm install
137-
138-
# Install server dependencies
139-
npm install --prefix server
140-
141-
# Install client dependencies (if using alternative client)
142-
npm install --prefix client
135+
npm run install:all
143136
```
137+
This installs root, server, and client dependencies in one step.
144138

145139
### Development
146140

@@ -166,9 +160,16 @@ This project is structured as a monorepo containing both a frontend (React/TypeS
166160
- Frontend: http://localhost:3000 (or the port shown in terminal)
167161
- Backend API: http://localhost:3001 (or configured port)
168162

163+
### Environment Variables
164+
165+
The frontend is built with Vite, so environment variables must be read from `import.meta.env` (for example, `import.meta.env.VITE_API_URL`). Using `process.env` will not work in the browser bundle.
166+
169167
### Building for Production
170168

171169
```bash
170+
# Build shared types first (required for server compilation)
171+
npx tsc --build src/types
172+
172173
# Build all components
173174
npm run build:all
174175

@@ -188,6 +189,15 @@ npm run lint:all
188189
npm run preview
189190
```
190191

192+
## Validation Checklist
193+
194+
- Build shared types: `npx tsc --build src/types`
195+
- Full build: `npm run build:all`
196+
- Lint: `npm run lint:all`
197+
- Manual smoke test:
198+
- Start backend: `npm run dev:server` and verify `curl http://localhost:3001/health` returns `{"status":"ok"}`.
199+
- Start frontend: `npm run dev:frontend`, visit http://localhost:3000, and navigate between Dashboard, Master Prompt Editor, and Advanced AI Toolkit. Press `Ctrl + /` to confirm the shortcuts panel appears.
200+
191201
## Security & Performance
192202

193203
This project implements comprehensive security measures and performance optimizations. For detailed information, see [SECURITY_OPTIMIZATION_REPORT.md](SECURITY_OPTIMIZATION_REPORT.md).

0 commit comments

Comments
 (0)