Skip to content

Commit

Permalink
updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
timrobinson33 committed Apr 8, 2021
1 parent 5401d10 commit fee7c8b
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 59 deletions.
89 changes: 31 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,43 @@
# Getting Started with Create React App
# Drug calculation checker app

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This application is primarily intended for community nurses in the UK to assist ***cross-checking*** of ***manual drug calculations*** when making up syringe pumps for palliative care patients.

## Available Scripts
**This application is not approved by NHS or any other healthcare body and you should not rely on it to perform drug calculations.**
**The authors accept no liability for any errors in the application.**

In the project directory, you can run:
The drug information is based on the back page of the NHS "Community Palliative Care Drug Chart" (Version 5 reviewed June 2017) with the addition of Fentanyl and Oxycodone.

### `yarn start`
You can run the app at [https://timrobinson33.github.io/drug-calc/](https://timrobinson33.github.io/drug-calc/).

Runs the app in the development mode.\
Open [http:https://localhost:3000](http:https://localhost:3000) to view it in the browser.
If you are using Chrome browser on Android, you can make a shortcut on your home screen by tapping **** in the top-right corner, then select "Add to Home screen".

The page will reload if you make edits.\
You will also see any lint errors in the console.
## Bugs and Suggestions
To report any errors or suggestions, if you have a github account you can raise an issue or submit a pull request; if not you can email me directly at [[email protected]](mailto:[email protected]).

### `yarn test`
## Technical info
The app is built with create-react-app and uses mvp.css

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.
## License
```
MIT License
### `yarn build`
Copyright (c) Tim Robinson
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `yarn 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)

### `yarn 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)
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
2 changes: 1 addition & 1 deletion src/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ function MainView() {
<span> {units}</span>
</div>
<div>
<label>Stat/PRN doses: </label>
<label>+ Stat/PRN doses: </label>
<select value={numStatDoses} disabled={showResults} onChange={e => selectNumStatDoses(parseInt(e.target.value))}>
{_.range(7).map(x => <option key={x} value={x}>{x}</option>)}
</select>
Expand Down

0 comments on commit fee7c8b

Please sign in to comment.