Skip to content
This repository has been archived by the owner on Sep 20, 2023. It is now read-only.

Commit

Permalink
docs(project): update readme. closes #78
Browse files Browse the repository at this point in the history
Signed-off-by: Rai Siqueira <rai93siqueira@gmail.com>
  • Loading branch information
raisiqueira authored and felipebonezi committed Jun 3, 2022
1 parent c19f54c commit f62f60d
Showing 1 changed file with 27 additions and 12 deletions.
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,39 @@
<h1 align="center">Justa Angular Library 🅰️</h1>

<p align="center">
[![Build Status](https://travis-ci.com/justapagamentos/justa-angular-library.svg?branch=master)](https://travis-ci.com/justapagamentos/justa-angular-library)
</p>

> An collection of _Angular Modules_ and _libraries_ used in some applications of the Justa Payments.
## Packages into this monorepo:

| Package | Description | Version | NPM Link | Bundle size | Status |
| -------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------ |
| mask-directive | Collection of Angular directives to use with input elements | ![npm (scoped)](https://img.shields.io/npm/v/@justa/mask-directive?color=%23076e95) | [@justa/mask-directive](https://www.npmjs.com/package/@justa/mask-directive) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/mask-directive?color=%23076e95) ||
| ng-validators | Collection of Angular reactive forms validators | ![npm (scoped)](https://img.shields.io/npm/v/@justa/ng-validators?color=%23076e95) | [@justa/ng-validators](https://www.npmjs.com/package/@justa/ng-validators) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/ng-validators?color=%23076e95) ||
| jst-pagination | Angular component that create a pagination interface without drama | ![npm (scoped)](https://img.shields.io/npm/v/@justa/jst-pagination?color=%23076e95) | [@justa/jst-pagination](https://www.npmjs.com/package/@justa/jst-pagination) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/jst-pagination?color=%23076e95) | ⚠️ |

# Justa Angular Library
**Legends**: ✅ (Active) | ⚠️ (Deprecated)

An collection of _Angular Modules_ and _libraries_ used in some applications of the Justa Payments.
## Contributing

## Packages
Clone this repo and install dependencies with [Yarn](http://yarnpkg.org/), after that you can start to help-us to improve these libraries.

| Package | Version | NPM Link | Bundle size |
|---------|---------|-----| ----------------- |
| jst-pagination | ![npm (scoped)](https://img.shields.io/npm/v/@justa/jst-pagination?color=%23076e95) | [@justa/jst-pagination](https://www.npmjs.com/package/@justa/jst-pagination) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/jst-pagination?color=%23076e95) |
| mask-directive | ![npm (scoped)](https://img.shields.io/npm/v/@justa/mask-directive?color=%23076e95) | [@justa/mask-directive](https://www.npmjs.com/package/@justa/mask-directive) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/mask-directive?color=%23076e95) |
| ng-validators | ![npm (scoped)](https://img.shields.io/npm/v/@justa/ng-validators?color=%23076e95) | [@justa/ng-validators](https://www.npmjs.com/package/@justa/ng-validators) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/ng-validators?color=%23076e95) |
| utilities | ![npm (scoped)](https://img.shields.io/npm/v/@justa/utilities?color=%23076e95) | [@justa/utilities](https://www.npmjs.com/package/@justa/utilities) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/utilities?color=%23076e95) |
All libraries are in the projects/justa folder. Before coding make sure if you are changing the right project and files.

## Develop only
### Develop and build any package

To see all changes across you development run these command to watch all changes:

```bash
ng build @justa/PACKAGE_NAME --watch
```

To run an project based on _project_ folder, run the this command:
And to build a package, you can run same command, but without the _watch_ flag:

```bash
ng build @justa/PROJECT_FOLDER --watch
ng build @justa/PACKAGE_NAME
```

## License
Expand Down

0 comments on commit f62f60d

Please sign in to comment.