felicity-lims/README.md

76 lines
2.8 KiB
Markdown
Raw Normal View History

2023-11-10 14:05:15 +08:00
# FELICITY LIMS FrontEnd VueJs
2021-10-17 21:41:46 +08:00
2021-10-17 21:53:13 +08:00
![Screenshot1](https://user-images.githubusercontent.com/17094364/137630249-b84e5b1c-f525-4b0a-8d1e-1e2820910a5f.png)
2021-10-17 21:54:22 +08:00
A next generation open source laboratory information management system for clinical/medical laboratories.
2021-10-17 21:04:50 +08:00
## Descritpion
2023-04-10 09:29:10 +08:00
The Felicity LIMS project aims to create a Laboratory Information Management System (LIMS) that tracks the complete laboratory workflow providing all the functionalities of a Laboratory Information Management System.
2021-10-17 21:41:46 +08:00
Felicity strives to promote an accurate flow of sample and associated experimental data to and through a laboratory to produce information that is used to make conclusions and critical decisions.
Felicity LIMS will ensure that sufficient metadata is captured and clinical laboratory personnel can track the lifecycle of a biospecimen in the laboratory from receipt to dispacth.
2023-11-10 14:05:15 +08:00
Felicity FrontEnd is developed in VueJs, URQL, and Tailwind CSS.
2021-10-17 21:41:46 +08:00
2021-10-17 21:54:22 +08:00
Felicity is the quality of being good, pleasant, or desirable.
2021-10-17 21:47:46 +08:00
## Main Features
2023-04-10 09:29:10 +08:00
2023-11-10 14:05:15 +08:00
- Dashboard
- Patient - Listing, compact, detail, search, Audit Log
- Sample - Listing, Detail, Audit Log, Reports, search
- Worksheet - Templates, listing, auto create, multi create, manual create
- Inventory - Item manager, listing, detail, transactios, adjustments, orders, requests
- Shipment - Fhir ready (experimental), Listing, detail,
- Storage - store rooms, locations, containers, templates,
- Admin - admin functions
- Client - listing, detail, contacts
2021-10-17 22:05:13 +08:00
## Installation
### Direct
2023-04-10 09:29:10 +08:00
2023-11-10 14:05:15 +08:00
#### Frontend Installation
2023-04-10 09:29:10 +08:00
2023-11-10 14:05:15 +08:00
Install [NodeJs](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions)
Install [Yarn](https://yarnpkg.com/getting-started/install)
2021-10-17 23:16:18 +08:00
Then follow instructions below
2023-04-10 09:29:10 +08:00
2021-10-17 23:11:18 +08:00
```shell
2023-11-10 14:05:15 +08:00
cd felicity/frontent/vite
yarn install
# for production mode
yarn build
yarn start
# for development mode
yarn dev
2023-04-10 09:29:10 +08:00
```
2021-10-17 22:05:13 +08:00
### Docker
2023-04-10 09:29:10 +08:00
2021-10-17 22:12:48 +08:00
This method uses Docker and docker-compose which handles the details of installing dependencies for you. On your Linux command line, run:
2023-04-10 09:29:10 +08:00
2021-10-17 22:51:36 +08:00
```shell
2021-10-17 23:11:18 +08:00
git clone https://github.com/aurthurm/felicity.git
cd felicity
docker-compose up -d
2021-10-17 22:12:48 +08:00
```
2023-04-10 09:29:10 +08:00
## Other projects
- Felicity Docs - Built with Laboratory QMS in Mind but can be used anywhere for document management
- Felicity Stocker - Medical Laboratory Inventory Management system
2022-01-13 05:06:57 +08:00
- Felicity Request - Requests and Approvals (e-Requisitions)
2022-11-06 18:17:59 +08:00
- Felicity Grind - Team Works, Project Management Tool, Issue Tracker
2022-01-13 05:06:57 +08:00
- Felicity Field - Survey Data Collection Tool, Forms ,Analytics etc
2023-04-10 09:29:10 +08:00
2021-10-17 22:12:48 +08:00
## Contact
2023-04-10 09:29:10 +08:00
- [EMail](mailto:aurthurmusendame@gmail.com?subject=[GitHub]%20Felicity%20Lims%20Enquiry)
- [Facebook](https://www.fb.me/aurthur.musendame)
- [LinkedIn](https://www.linkedin.com/in/aurthurmusendame)
- [Whatsapp](https://api.WhatsApp.com/send?phone=263776406399)
- [Telegram](https://www.t.me/aurthurm)