About The Project

@lamimed/utils is an npm package with a collection of utility functions, hooks, and patterns that aims to allow code sharing between all the Lami frontends projects.

Built With

The Project comes with a complete set of modern tools and libraries, including:

• Parcel
• TypeScript
• Eslint
• Prettier
• Husky
• Size Limit

Getting Started

Some information for a quick installation of the project

Prerequisites

• pnpm

  corepack enable

Installation

This builds to /dist and runs the project in watch mode so any edits you save inside src cause a rebuild to /dist.

1. Clone the repo using SSH

   git clone [email protected]:lami-health/utils-frontend.git

2. Install Pnpm packages

   pnpm i

3. Running the project

   pnpm start

4. Using the project locally (with Yarn):

   yarn link

Publishing the library

To update the package, after being assured that the build has been done, change the version in package.json, login to npm and publish the package.

pnpm login

Write the username and the password. And then:

pnpm publish

Bundle analysis

Calculate the real cost of your library using size-limit with yarn size, or visualize detailed analysis running pnpm build and opening parcel-bundle-reports/main.html in the browser.

Usage

Project structure:

# To be defined

Continuous Integration

GitHub Actions

Three actions are added by default:

• main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
• publish which publish the package to npmjs on main pushes.
• size which comments cost comparison of your library on every pull request using size-limit

Contributing

We use the tag generated in Jira, so it links the commit to the jira card.

1. Create your Feature Branch (git checkout -b feature/TEC-2-Amazing-Feature)
2. Commit your Changes (git commit -m 'feat: add some amazing feature')
3. Push to the Branch (git push origin feature/TEC-2-Amazing-Feature)
4. Open a Pull Request

Semantic commit messages

Screenshot: