Update README.md

This commit is contained in:
TheLeo 2025-11-21 22:40:16 +00:00
parent 6038783d63
commit 208c33d242

View File

@ -90,40 +90,10 @@ Now that the team is using it, add features based on actual needs
9. **Backup/restore** - Easy database backup 9. **Backup/restore** - Easy database backup
### Iteration Strategy ### Iteration Strategy
- Get feedback from the 3 users after first week - Get feedback from users after first week
- Pick ONE feature to add based on biggest pain point - Pick ONE feature to add based on biggest pain point
- Implement, test, repeat - Implement, test, repeat
- Don't add features "just because" - only add what team actually needs - Don't add features "just because" - only add what is actually needed
---
## Quick Start Guide (Day 1 Setup)
### Backend Setup
```bash
mkdir ka-system-backend
cd ka-system-backend
npm init -y
npm install express better-sqlite3 cors
```
Create minimal file structure:
- `server.js` - Express server
- `db.js` - Database setup and queries
- `database.db` - SQLite database (created automatically)
### Frontend Setup
```bash
npm create vite@latest ka-system-frontend -- --template react
cd ka-system-frontend
npm install
npm install axios react-quill
```
### Running the System
1. Terminal 1: `node server.js` (backend on port 3001)
2. Terminal 2: `npm run dev` (frontend on port 5173)
3. Open browser to `localhost:5173`
--- ---
@ -135,8 +105,6 @@ npm install axios react-quill
- [ ] All 3 team members can run it on their machines - [ ] All 3 team members can run it on their machines
- [ ] No critical bugs that prevent basic use - [ ] No critical bugs that prevent basic use
If these work, you have a successful MVP. Everything else is polish.
--- ---
## Database Schema (Minimal) ## Database Schema (Minimal)
@ -152,12 +120,6 @@ CREATE TABLE articles (
); );
``` ```
Add indexes after MVP if search is slow:
```sql
CREATE INDEX idx_title ON articles(title);
CREATE INDEX idx_content ON articles(content);
```
--- ---
## Risk Management ## Risk Management
@ -172,4 +134,3 @@ CREATE INDEX idx_content ON articles(content);
- Set a timer for each task, move on if taking too long - Set a timer for each task, move on if taking too long
- Use libraries, don't reinvent the wheel - Use libraries, don't reinvent the wheel
- Manual testing only for week 1 - Manual testing only for week 1
- Share progress daily with team