Add localization support and docs
This commit is contained in:
82
docs/2025-10-18_MODULAR_STRUCTURE.md
Normal file
82
docs/2025-10-18_MODULAR_STRUCTURE.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# Medication Plan Assistant - Modular Structure
|
||||
|
||||
This application has been successfully modularized to simplify maintenance and further development.
|
||||
|
||||
## 📁 New Project Structure
|
||||
|
||||
```text
|
||||
src/
|
||||
├── App.js # Main component (greatly simplified)
|
||||
├── components/ # UI components
|
||||
│ ├── DoseSchedule.js # Dosage schedule input
|
||||
│ ├── DeviationList.js # Deviations from the schedule
|
||||
│ ├── SuggestionPanel.js # Correction suggestions
|
||||
│ ├── SimulationChart.js # Chart component
|
||||
│ ├── Settings.js # Settings panel
|
||||
│ ├── TimeInput.js # Time input with picker
|
||||
│ └── NumericInput.js # Numeric input with +/- buttons
|
||||
├── hooks/ # Custom React hooks
|
||||
│ ├── useAppState.js # State management & local storage
|
||||
│ └── useSimulation.js # Simulation logic & calculations
|
||||
├── utils/ # Utility functions
|
||||
│ ├── timeUtils.js # Time utility functions
|
||||
│ ├── pharmacokinetics.js # PK calculations
|
||||
│ ├── calculations.js # Concentration calculations
|
||||
│ └── suggestions.js # Correction suggestion algorithm
|
||||
└── constants/
|
||||
└── defaults.js # Constants & default values
|
||||
```
|
||||
|
||||
## 🎯 Advantages of the new structure
|
||||
|
||||
### ✅ Better maintainability
|
||||
|
||||
- **Small, focused modules**: Each file has a clear responsibility
|
||||
- **Easier debugging**: Problems can be localized more quickly
|
||||
- **Clearer code organization**: Related functions are grouped together
|
||||
|
||||
### ✅ Reusability
|
||||
|
||||
- **UI components**: `TimeInput`, `NumericInput` can be used anywhere
|
||||
- **Utility functions**: PK calculations are isolated and testable
|
||||
- **Custom hooks**: State logic is reusable
|
||||
|
||||
### ✅ Development friendliness
|
||||
|
||||
- **Parallel development**: Teams can work on different modules
|
||||
- **Simpler testing**: Each module can be tested in isolation
|
||||
- **Better IDE support**: Smaller files = better performance
|
||||
|
||||
### ✅ Scalability
|
||||
|
||||
- **New features**: Easy to add as new modules
|
||||
- **Code splitting**: Possible for better performance
|
||||
- **Refactoring**: Changes are limited locally
|
||||
|
||||
## 🔧 Technical details
|
||||
|
||||
### State management
|
||||
|
||||
- **useAppState**: Manages global app state and LocalStorage
|
||||
- **useSimulation**: Manages all simulation-related calculations
|
||||
|
||||
### Component architecture
|
||||
|
||||
- **Dumb components**: UI components receive props and call callbacks
|
||||
- **Smart Components**: Hooks manage state and business logic
|
||||
- **Separation of Concerns**: UI, state, and business logic are separated
|
||||
|
||||
### Utils & Calculations
|
||||
|
||||
- **Pure functions**: All calculations are side-effect-free
|
||||
- **Modular exports**: Functions can be imported individually
|
||||
- **Typed interfaces**: Clear input/output definitions
|
||||
|
||||
## 🚀 Migration complete
|
||||
|
||||
The application works identically to the original version, but now:
|
||||
|
||||
- Split into **350+ lines** across **several small modules**
|
||||
- **Easier to understand** and modify
|
||||
- **Ready for further features** and improvements
|
||||
- **More test-friendly** for unit and integration tests
|
||||
70
docs/README.create-react-app.md
Normal file
70
docs/README.create-react-app.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# Getting Started with Create React App
|
||||
|
||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||||
|
||||
## Available Scripts
|
||||
|
||||
In the project directory, you can run:
|
||||
|
||||
### `npm start`
|
||||
|
||||
Runs the app in the development mode.\
|
||||
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
|
||||
|
||||
The page will reload when you make changes.\
|
||||
You may also see any lint errors in the console.
|
||||
|
||||
### `npm test`
|
||||
|
||||
Launches the test runner in the interactive watch mode.\
|
||||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
||||
|
||||
### `npm run build`
|
||||
|
||||
Builds the app for production to the `build` folder.\
|
||||
It correctly bundles React in production mode and optimizes the build for the best performance.
|
||||
|
||||
The build is minified and the filenames include the hashes.\
|
||||
Your app is ready to be deployed!
|
||||
|
||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
||||
|
||||
### `npm run eject`
|
||||
|
||||
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
|
||||
|
||||
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
|
||||
|
||||
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
|
||||
|
||||
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
|
||||
|
||||
## Learn More
|
||||
|
||||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
||||
|
||||
To learn React, check out the [React documentation](https://reactjs.org/).
|
||||
|
||||
### Code Splitting
|
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
|
||||
|
||||
### Analyzing the Bundle Size
|
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
|
||||
|
||||
### Making a Progressive Web App
|
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
|
||||
|
||||
### Advanced Configuration
|
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
|
||||
|
||||
### Deployment
|
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
|
||||
|
||||
### `npm run build` fails to minify
|
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
|
||||
Reference in New Issue
Block a user