https://github.com/jxareas/polylab

An Angular client for the information management module of a sample Laboratory Information System (LIS).
https://github.com/jxareas/polylab

Last synced: 7 months ago
JSON representation

An Angular client for the information management module of a sample Laboratory Information System (LIS).

• Host: GitHub
• URL: https://github.com/jxareas/polylab
• Owner: jxareas
• License: agpl-3.0
• Created: 2023-05-13T05:10:28.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T04:38:41.000Z (over 1 year ago)
• Last Synced: 2025-01-20T23:47:03.332Z (9 months ago)
• Language: CSS
• Homepage:
• Size: 19.4 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          







  

   

    

  




PolyLab



    

  


    A sample Angular micro front-end for a LIMS

    


    

    Screenshots

    ·

    Requirements

    ·

    Architecture

    ·

     Technologies

    ·

    License

  



**PolyLab** is a sample Angular micro front-end for a Laboratory Information Management System (LIMS). It provides a user-friendly interface for managing laboratory data and workflows.

## 📷 Screenshots 📷

PolyLab's user interface is crafted with a focus on simplicity, elegance, interactivity and intuitive user experience. The thoughtful color palette and typography choices enhance readability and ensure a visually appealing presentation of data.

It seamlessly integrates both dark and light modes, allowing users to effortlessly switch between the two based on their preferences.

| Light                                      | Night                                     |

| ------------------------------------------ | ----------------------------------------- |

| ![](readme-assets/images/home_light.png)   | ![](readme-assets/images/home_dark.png)   |

| ![](readme-assets/images/crud_light.png)   | ![](readme-assets/images/crud_dark.png)   |

| ![](readme-assets/images/drawer_light.png) | ![](readme-assets/images/drawer_dark.png) |

## 📝 Requirements 📝

PolyLab has the following requirements:

- Node.js 18.16.0 or higher, as specified by the [`.nvmrc`](/.nvmrc) file.

- Angular CLI 16.0 or higher

- [PolyLab API](<(https://github.com/jxareas/PolyLab-REST)>) to connect to

Here are the instructions on how to setup the project locally:

1. Install and run the [PolyLab-API](https://github.com/jxareas/PolyLab-API).

2. Clone the repo

```bash

git clone https://github.com/jxareas/PolyLab.git

```

3. Install NPM packages

```bash

yarn install

```

## 🛠 Architecture 🛠

**PolyLab** follows a micro front-end architecture, using Angular as the front-end

framework.

It is designed to be integrated with a [backend API](https://github.com/jxareas/PolyLab-API) that provides the necessary data and functionality for managing laboratory information.

This project is built using a modular approach, with each module encapsulating a specific set of features.

## 🦾 Technologies 🦾

The project uses the following frameworks & libraries:

- **Angular**: a comprehensive framework that allows for the development of dynamic, high-performance web applications.

- **TypeScript**: a strongly typed superset of JavaScript that compiles to plain JavaScript. It brings static typing, enhanced tooling, and improved developer experience to the JavaScript ecosystem.

- **RxJs**: a reactive programming library that enables handling asynchronous and event-based programming in a more convenient and efficient manner. It provides powerful tools for composing and manipulating asynchronous streams of data.

- **PrimeNG**: a collection of rich UI components for Angular applications. It offers a wide range of customizable and feature-rich components such as data tables, forms, charts, and more

- **Angular Material**: a UI component library built by the Angular team that provides a rich set of pre-built UI components based on Google's Material Design guidelines.

- **ESLint**: a pluggable static code analysis tool for identifying problematic patterns found in JavaScript and TypeScript code.

- **Lint-staged**: a tool that allows running linters on staged files in a Git repository. It works in conjunction with Husky and enables developers to define specific linting tasks to be performed on files that are staged for committing.

- **Husky**: a git hook management tool that allows running scripts or commands before git events such as commit, push, and more.

- **Prettier**: an opinionated code formatter that enforces consistent code style and formatting rules across the project.

(back to top)


## 📜 License 📜

PolyLab is licensed under the [GNU Affero GPL v3.0](https://github.com/jxareas/PolyLab/blob/master/LICENSE).

(back to top)