Skip to content

Commit c149edd

Browse files
committed
docs: enhance README with features, tech stack, and project structure
1 parent 77d3bad commit c149edd

1 file changed

Lines changed: 47 additions & 1 deletion

File tree

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
# Op Notes
22

3-
Surgery notes management system for hospitals.
3+
A cross-platform desktop application for managing surgical notes in hospitals. Built with Electron, React, and SQLite.
4+
5+
## Features
6+
7+
- **Patient Management**: Track patient records with PHN, demographics, and contact information
8+
- **Surgery Records**: Document surgeries with operation notes, post-op notes, and follow-ups
9+
- **Doctor Management**: Maintain doctor profiles with designations and SLMC registration
10+
- **Full-Text Search**: Quickly find patients, surgeries, and doctors
11+
- **Print Support**: Generate printable operation notes and follow-up records
12+
- **Offline-First**: All data stored locally in SQLite database
13+
14+
## Tech Stack
15+
16+
- **Frontend**: React 18, TypeScript, Tailwind CSS, Radix UI
17+
- **Backend**: Electron 28, SQLite (better-sqlite3), Kysely
18+
- **Build**: electron-vite, electron-builder
19+
- **Forms**: React Hook Form + Zod validation
20+
- **Data Fetching**: TanStack React Query
421

522
## Recommended IDE Setup
623

@@ -32,3 +49,32 @@ $ pnpm build:mac
3249
# For Linux
3350
$ pnpm build:linux
3451
```
52+
53+
### Other Commands
54+
55+
```bash
56+
$ pnpm lint # Run ESLint with auto-fix
57+
$ pnpm typecheck # TypeScript type checking
58+
$ pnpm format # Format code with Prettier
59+
```
60+
61+
## Project Structure
62+
63+
```
64+
src/
65+
├── main/ # Electron main process
66+
│ ├── db/ # Database migrations
67+
│ └── repository/ # Data access layer
68+
├── preload/ # Electron preload scripts (IPC bridge)
69+
├── renderer/ # React frontend
70+
│ └── src/
71+
│ ├── components/ # UI components
72+
│ ├── routes/ # Page components
73+
│ ├── contexts/ # React Context providers
74+
│ └── hooks/ # Custom React hooks
75+
└── shared/ # Shared types and models
76+
```
77+
78+
## License
79+
80+
MIT

0 commit comments

Comments
 (0)