ai-ebm-assistant-v4 0.2.26 → 0.2.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +119 -119
- package/dist/index.es.js +1779 -1677
- package/dist/index.umd.js +54 -54
- package/package.json +122 -122
package/README.md
CHANGED
|
@@ -1,119 +1,119 @@
|
|
|
1
|
-
# EBM AI Assistant
|
|
2
|
-
|
|
3
|
-
## Project Description
|
|
4
|
-
EBM AI Assistant is a clinical decision support system that provides AI-powered Evidence-Based Medicine (EBM) recommendations directly within physician workflows during active patient encounters. It's built on top of Vite, React, and MUI library.
|
|
5
|
-
|
|
6
|
-
## Setup
|
|
7
|
-
|
|
8
|
-
### Prerequisites
|
|
9
|
-
- Node.js (v20)
|
|
10
|
-
- npm or yarn
|
|
11
|
-
|
|
12
|
-
### Installation
|
|
13
|
-
|
|
14
|
-
1. Clone the repository:
|
|
15
|
-
```bash
|
|
16
|
-
git clone <repository_url>
|
|
17
|
-
```
|
|
18
|
-
2. Install dependencies:
|
|
19
|
-
```bash
|
|
20
|
-
npm install
|
|
21
|
-
# or yarn install
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## Available Scripts
|
|
25
|
-
|
|
26
|
-
In the project directory, you can run:
|
|
27
|
-
|
|
28
|
-
### `npm run dev`
|
|
29
|
-
Runs the app in development mode.
|
|
30
|
-
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
|
|
31
|
-
|
|
32
|
-
The page will reload if you make edits.
|
|
33
|
-
You will also see any lint errors in the console.
|
|
34
|
-
|
|
35
|
-
### `npm run build`
|
|
36
|
-
Builds the app for production to the `dist` folder.
|
|
37
|
-
It correctly bundles Preact in production mode and optimizes the build for the best performance.
|
|
38
|
-
|
|
39
|
-
The build is minified and the filenames include the hashes.
|
|
40
|
-
Your app is ready to be deployed!
|
|
41
|
-
|
|
42
|
-
### `npm run preview`
|
|
43
|
-
Locally previews the production build.
|
|
44
|
-
|
|
45
|
-
### `npm run generate`
|
|
46
|
-
Runs Plop to generate new components or atoms based on templates.
|
|
47
|
-
|
|
48
|
-
## Technologies Used
|
|
49
|
-
|
|
50
|
-
- **React**: A JavaScript library for building user interfaces, maintained by Facebook and a community of individual developers and companies.
|
|
51
|
-
- **Material-UI (MUI)**: A comprehensive React UI toolset for building features faster.
|
|
52
|
-
- **Vite**: A next-generation frontend tooling that provides an extremely fast development experience.
|
|
53
|
-
- **Axios**: Promise-based HTTP client for the browser and Node.js.
|
|
54
|
-
- **Node.js**: JavaScript runtime environment(v20).
|
|
55
|
-
- **npm / Yarn**: Package managers for JavaScript.
|
|
56
|
-
|
|
57
|
-
## Publishing to NPM
|
|
58
|
-
|
|
59
|
-
This project's components are designed to be published as an NPM package. There are two primary ways to publish updates:
|
|
60
|
-
|
|
61
|
-
### Manual Publishing
|
|
62
|
-
|
|
63
|
-
Follow these steps for a manual publishing process:
|
|
64
|
-
|
|
65
|
-
1. **Build and Commit**: First, build the library and commit your changes.
|
|
66
|
-
```bash
|
|
67
|
-
npm run build
|
|
68
|
-
git add .
|
|
69
|
-
git commit -m 'Your descriptive commit message'
|
|
70
|
-
```
|
|
71
|
-
2. **Update Version**: Increment the package version using one of the following commands:
|
|
72
|
-
- `npm version patch`: For bug fixes.
|
|
73
|
-
- `npm version minor`: For a new component addition.
|
|
74
|
-
- `npm version major`: For a completed feature.
|
|
75
|
-
3. **NPM Login**: Log in to your NPM account (if not already logged in).
|
|
76
|
-
```bash
|
|
77
|
-
npm login
|
|
78
|
-
```
|
|
79
|
-
4. **Publish**: Publish the package to NPM.
|
|
80
|
-
```bash
|
|
81
|
-
npm publish --access public
|
|
82
|
-
```
|
|
83
|
-
5. **Verify**: Check the version update on the NPM website after publishing.
|
|
84
|
-
|
|
85
|
-
### Automated Publishing with `publish.sh`
|
|
86
|
-
|
|
87
|
-
To automate the publishing process, you can use the provided `publish.sh` script. This script handles installing dependencies, committing changes (with a message like "Release: EBM AI Assistant package <version>"), updating the package version (patch, minor, or major based on your input), building the library, logging into NPM (using environment variables), and publishing the package.
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
1. **Run the Publish Script**: Execute the `publish.sh` script with the desired version type (patch, minor, or major).
|
|
91
|
-
```bash
|
|
92
|
-
./publish.sh <version_type>
|
|
93
|
-
```
|
|
94
|
-
*Example: `./publish.sh patch`*
|
|
95
|
-
*Example: `./publish.sh minor`*
|
|
96
|
-
*Example: `./publish.sh major`*
|
|
97
|
-
|
|
98
|
-
2. **Verify**: Check the version update on the NPM website after publishing.
|
|
99
|
-
|
|
100
|
-
For more details on manual publishing, refer to the [NPM documentation](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages).
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
## Project Structure (Initial Observations)
|
|
104
|
-
- `src/`: Contains the main application source code.
|
|
105
|
-
- `app.jsx`: Serves as a playground for developing and testing components in isolation before they are packaged for NPM. It's where new components are integrated and demonstrated.
|
|
106
|
-
- `main.jsx`: Main application entry point for the development server.
|
|
107
|
-
- `components/`: Reusable UI components, intended to be part of the published NPM package.
|
|
108
|
-
- `aiAssistant/`: A significant part of the application, likely an AI-powered chat or assistant interface.
|
|
109
|
-
- `atoms/`: Potentially smaller, more granular components or state management entities.
|
|
110
|
-
- `assets/`: Static assets like images or SVGs.
|
|
111
|
-
- `store/`: Suggests state management (e.g., Zustand, Redux, Context API).
|
|
112
|
-
- `plop-templates/`: Templates for generating new code using Plop.
|
|
113
|
-
- `dist/`: Output directory for production builds.
|
|
114
|
-
- `vite.config.js`: Vite configuration file.
|
|
115
|
-
- `package.json`: Project dependencies and scripts.
|
|
116
|
-
|
|
117
|
-
## Vite Library Mode
|
|
118
|
-
This project leverages Vite's library mode (`vite build --watch --mode library`) to build components into a shareable NPM package. This configuration optimizes the output for library consumption, making it easy to integrate these components into other projects. The `app.jsx` serves as a development playground to test these components during their creation.
|
|
119
|
-
>>>>>>> 8f6a73d2b26a69176b7837f59d48d812e915fa85
|
|
1
|
+
# EBM AI Assistant
|
|
2
|
+
|
|
3
|
+
## Project Description
|
|
4
|
+
EBM AI Assistant is a clinical decision support system that provides AI-powered Evidence-Based Medicine (EBM) recommendations directly within physician workflows during active patient encounters. It's built on top of Vite, React, and MUI library.
|
|
5
|
+
|
|
6
|
+
## Setup
|
|
7
|
+
|
|
8
|
+
### Prerequisites
|
|
9
|
+
- Node.js (v20)
|
|
10
|
+
- npm or yarn
|
|
11
|
+
|
|
12
|
+
### Installation
|
|
13
|
+
|
|
14
|
+
1. Clone the repository:
|
|
15
|
+
```bash
|
|
16
|
+
git clone <repository_url>
|
|
17
|
+
```
|
|
18
|
+
2. Install dependencies:
|
|
19
|
+
```bash
|
|
20
|
+
npm install
|
|
21
|
+
# or yarn install
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Available Scripts
|
|
25
|
+
|
|
26
|
+
In the project directory, you can run:
|
|
27
|
+
|
|
28
|
+
### `npm run dev`
|
|
29
|
+
Runs the app in development mode.
|
|
30
|
+
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
|
|
31
|
+
|
|
32
|
+
The page will reload if you make edits.
|
|
33
|
+
You will also see any lint errors in the console.
|
|
34
|
+
|
|
35
|
+
### `npm run build`
|
|
36
|
+
Builds the app for production to the `dist` folder.
|
|
37
|
+
It correctly bundles Preact in production mode and optimizes the build for the best performance.
|
|
38
|
+
|
|
39
|
+
The build is minified and the filenames include the hashes.
|
|
40
|
+
Your app is ready to be deployed!
|
|
41
|
+
|
|
42
|
+
### `npm run preview`
|
|
43
|
+
Locally previews the production build.
|
|
44
|
+
|
|
45
|
+
### `npm run generate`
|
|
46
|
+
Runs Plop to generate new components or atoms based on templates.
|
|
47
|
+
|
|
48
|
+
## Technologies Used
|
|
49
|
+
|
|
50
|
+
- **React**: A JavaScript library for building user interfaces, maintained by Facebook and a community of individual developers and companies.
|
|
51
|
+
- **Material-UI (MUI)**: A comprehensive React UI toolset for building features faster.
|
|
52
|
+
- **Vite**: A next-generation frontend tooling that provides an extremely fast development experience.
|
|
53
|
+
- **Axios**: Promise-based HTTP client for the browser and Node.js.
|
|
54
|
+
- **Node.js**: JavaScript runtime environment(v20).
|
|
55
|
+
- **npm / Yarn**: Package managers for JavaScript.
|
|
56
|
+
|
|
57
|
+
## Publishing to NPM
|
|
58
|
+
|
|
59
|
+
This project's components are designed to be published as an NPM package. There are two primary ways to publish updates:
|
|
60
|
+
|
|
61
|
+
### Manual Publishing
|
|
62
|
+
|
|
63
|
+
Follow these steps for a manual publishing process:
|
|
64
|
+
|
|
65
|
+
1. **Build and Commit**: First, build the library and commit your changes.
|
|
66
|
+
```bash
|
|
67
|
+
npm run build
|
|
68
|
+
git add .
|
|
69
|
+
git commit -m 'Your descriptive commit message'
|
|
70
|
+
```
|
|
71
|
+
2. **Update Version**: Increment the package version using one of the following commands:
|
|
72
|
+
- `npm version patch`: For bug fixes.
|
|
73
|
+
- `npm version minor`: For a new component addition.
|
|
74
|
+
- `npm version major`: For a completed feature.
|
|
75
|
+
3. **NPM Login**: Log in to your NPM account (if not already logged in).
|
|
76
|
+
```bash
|
|
77
|
+
npm login
|
|
78
|
+
```
|
|
79
|
+
4. **Publish**: Publish the package to NPM.
|
|
80
|
+
```bash
|
|
81
|
+
npm publish --access public
|
|
82
|
+
```
|
|
83
|
+
5. **Verify**: Check the version update on the NPM website after publishing.
|
|
84
|
+
|
|
85
|
+
### Automated Publishing with `publish.sh`
|
|
86
|
+
|
|
87
|
+
To automate the publishing process, you can use the provided `publish.sh` script. This script handles installing dependencies, committing changes (with a message like "Release: EBM AI Assistant package <version>"), updating the package version (patch, minor, or major based on your input), building the library, logging into NPM (using environment variables), and publishing the package.
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
1. **Run the Publish Script**: Execute the `publish.sh` script with the desired version type (patch, minor, or major).
|
|
91
|
+
```bash
|
|
92
|
+
./publish.sh <version_type>
|
|
93
|
+
```
|
|
94
|
+
*Example: `./publish.sh patch`*
|
|
95
|
+
*Example: `./publish.sh minor`*
|
|
96
|
+
*Example: `./publish.sh major`*
|
|
97
|
+
|
|
98
|
+
2. **Verify**: Check the version update on the NPM website after publishing.
|
|
99
|
+
|
|
100
|
+
For more details on manual publishing, refer to the [NPM documentation](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages).
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
## Project Structure (Initial Observations)
|
|
104
|
+
- `src/`: Contains the main application source code.
|
|
105
|
+
- `app.jsx`: Serves as a playground for developing and testing components in isolation before they are packaged for NPM. It's where new components are integrated and demonstrated.
|
|
106
|
+
- `main.jsx`: Main application entry point for the development server.
|
|
107
|
+
- `components/`: Reusable UI components, intended to be part of the published NPM package.
|
|
108
|
+
- `aiAssistant/`: A significant part of the application, likely an AI-powered chat or assistant interface.
|
|
109
|
+
- `atoms/`: Potentially smaller, more granular components or state management entities.
|
|
110
|
+
- `assets/`: Static assets like images or SVGs.
|
|
111
|
+
- `store/`: Suggests state management (e.g., Zustand, Redux, Context API).
|
|
112
|
+
- `plop-templates/`: Templates for generating new code using Plop.
|
|
113
|
+
- `dist/`: Output directory for production builds.
|
|
114
|
+
- `vite.config.js`: Vite configuration file.
|
|
115
|
+
- `package.json`: Project dependencies and scripts.
|
|
116
|
+
|
|
117
|
+
## Vite Library Mode
|
|
118
|
+
This project leverages Vite's library mode (`vite build --watch --mode library`) to build components into a shareable NPM package. This configuration optimizes the output for library consumption, making it easy to integrate these components into other projects. The `app.jsx` serves as a development playground to test these components during their creation.
|
|
119
|
+
>>>>>>> 8f6a73d2b26a69176b7837f59d48d812e915fa85
|