felicity-lims/README.md
2021-10-17 17:19:31 +02:00

2.8 KiB

FELICITY LIMS

Screenshot1

A next generation open source laboratory information management system for clinical/medical laboratories.

Descritpion

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.

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.

Felicity Backend is developed in Python using the FastAPI framework and strawberry GraphQL. Felicity FrontEnd is developed in VueJs, URQL, and Tailwind CSS.

Felicity is the quality of being good, pleasant, or desirable.

Main Features

  • Sample status tracking
  • Flexible batched sample workflow
  • Quality control
  • Reporting
  • Highly customizable and extensible
  • Micro kanban Project management
  • Experimental Markdown Document manager

Installation

Direct

Backend Installation

using poetry

Fist install Poetry Then follow instructions below

git clone https://github.com/aurthurm/felicity.git
cd felicity
cd backend/felicity_lims
poetry install
bash felicity.sh &
using anaconda

Fist install Miniconda Then follow instructions below

conda create -n felicity python=3.9
conda activate felicity
git clone https://github.com/aurthurm/felicity.git
cd felicity
cd backend/felicity_lims
pip install -r requirements.txt
bash felicity.sh &

Frontend Installation

Install NodeJs Install Yarn Then follow instructions below

cd felicity/frontent/vite
yarn install
# for production mode
yarn build
yarn start
# for development mode
yarn dev

Docker

This method uses Docker and docker-compose which handles the details of installing dependencies for you. On your Linux command line, run:

git clone https://github.com/aurthurm/felicity.git
cd felicity
docker-compose up -d

Contact