Update readmes
This commit is contained in:
40
README.md
40
README.md
@@ -1,14 +1,44 @@
|
||||
# Medication Plan Assistant
|
||||
|
||||
## Basic Setup
|
||||
A pharmacokinetic simulation tool for Lisdexamfetamine (LDX) and d-Amphetamine medication planning with real-time visualization and dose adjustment suggestions.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
```sh
|
||||
# Install dependencies
|
||||
npm install -D recharts tailwindcss postcss autoprefixer nodemon
|
||||
|
||||
# Initialize tailwind CSS (creates config files)
|
||||
npx tailwindcss init -p
|
||||
npm install
|
||||
|
||||
# Run the development server
|
||||
npm start
|
||||
|
||||
# Build for production
|
||||
npm run build
|
||||
```
|
||||
|
||||
The app will be available at `http://localhost:3000` (or `http://0.0.0.0:3000` in dev containers).
|
||||
|
||||
## 🛠️ Tech Stack
|
||||
|
||||
- **React 19.1** with TypeScript
|
||||
- **shadcn/ui** component library (Radix UI primitives)
|
||||
- **Tailwind CSS** for styling
|
||||
- **Recharts** for concentration-time charts
|
||||
- **Create React App** as build tool
|
||||
|
||||
## 📋 Features
|
||||
|
||||
- Interactive dose schedule planning with 5 daily time slots
|
||||
- Real-time pharmacokinetic simulation
|
||||
- Deviation tracking from planned doses
|
||||
- Automatic correction suggestions
|
||||
- Dual chart view (LDX, d-Amphetamine, or both)
|
||||
- Advanced PK parameter configuration
|
||||
- Multi-language support (English/German)
|
||||
- Local storage persistence
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
See the [docs/](./docs) folder for detailed documentation:
|
||||
- [Development Notes](./docs/README.dev-notes.md) - Setup and troubleshooting
|
||||
- [Modular Structure](./docs/2025-10-18_MODULAR_STRUCTURE.md) - Architecture overview
|
||||
- [Dev Container Setup](./docs/README.devcontainer.md) - WSL2/Podman configuration
|
||||
|
||||
Reference in New Issue
Block a user