Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brazilian-utils/brazilian-utils
Utils library for specific Brazilian businesses
https://github.com/brazilian-utils/brazilian-utils
boleto boleto-bancario brazilian cep cnpj cpf email estados format formatter generator gerador inscricao-estadual mask phone pis processo-juridico states validador validator
Last synced: about 1 month ago
JSON representation
Utils library for specific Brazilian businesses
- Host: GitHub
- URL: https://github.com/brazilian-utils/brazilian-utils
- Owner: brazilian-utils
- License: mit
- Created: 2018-06-08T17:52:41.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-08-28T12:48:21.000Z (about 1 year ago)
- Last Synced: 2024-04-04T09:02:53.042Z (5 months ago)
- Topics: boleto, boleto-bancario, brazilian, cep, cnpj, cpf, email, estados, format, formatter, generator, gerador, inscricao-estadual, mask, phone, pis, processo-juridico, states, validador, validator
- Language: TypeScript
- Homepage: https://brazilian-utils.com.br
- Size: 4.53 MB
- Stars: 1,325
- Watchers: 29
- Forks: 100
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-made-by-brazilians - brazilian-utils
README
π§π· Brazilian Utils
Utils library for Brazilian-specific businesses.
[π Documentation](https://brazilian-utils.com.br/#/getting-started)
[![Build Status](https://github.com/brazilian-utils/brazilian-utils/workflows/build/badge.svg?branch=main)](https://github.com/brazilian-utils/brazilian-utils/actions?query=workflow%3Abuild) [![Coverage Status](https://codecov.io/gh/brazilian-utils/brazilian-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/brazilian-utils/brazilian-utils) [![Known Vulnerabilities](https://snyk.io/test/github/brazilian-utils/brazilian-utils/badge.svg?targetFile=package.json)](https://snyk.io/test/github/brazilian-utils/brazilian-utils?targetFile=package.json) [![Maintainability](https://api.codeclimate.com/v1/badges/05d3cd8492ed438bf51d/maintainability)](https://codeclimate.com/github/hyanmandian/brazilian-utils/maintainability)
[![Downloads per month](https://img.shields.io/npm/dm/@brazilian-utils/brazilian-utils.svg)](https://www.npmjs.com/package/@brazilian-utils/brazilian-utils) [![License: MIT](https://img.shields.io/github/license/hyanmandian/brazilian-utils.svg)](LICENSE)---
> ## Vidas Negras Importam | Black Lives Matter. βπ½βπΎβπΏ
>
> To know how to help, just go to [Vidas Negras Importam](https://vidasnegrasimportam.carrd.co/) or [Black Lives Matter](https://blacklivesmatters.carrd.co/).---
> ## We are changing
>
> After one year of Brazilian Utils and lots of feedback, we decided to refactor our library to fix issues, create a website and make it easier for other developers to contribute. If you use **v0 version**, please, check [v0](https://github.com/brazilian-utils/brazilian-utils/tree/v0) branch.---
**Table of Contents**
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Contributors](#contributors)
- [License](#license)# Getting Started
Brazilian Utils is a library focused on solving problems that we face daily in the development of applications for the Brazilian business.
## Installation
Using **Brazilian Utils** is quite simple and you can use it in some ways:
as npm package:
```bash
npm install --save @brazilian-utils/brazilian-utils
```with yarn package manager:
```bash
yarn add @brazilian-utils/brazilian-utils
```or `` tag (global `brazilianUtils`):
```html
<script src="https://unpkg.com/@brazilian-utils/brazilian-utils/dist/brazilian-utils.cjs.production.min.js">
```## Usage
To use one of our utilities you just need to import the required function as in the example below:
```javascript
import { isValidCPF } from '@brazilian-utils/brazilian-utils';isValidCPF('1232454233345'); // false
```You can check a list of utilities [by clicking here](https://brazilian-utils.com.br/#/utilities).
## Contributors
Our "thank you" goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
Hyan Mandian
π» π π€ β οΈ
Lucas Veloso
π» π π€ β οΈ
Andreo Vieira
π» π π€ π§
Matheus Almeida
π» π β οΈ
Fernando Rogelin
π» π β οΈ
rodineijf
π» π β οΈ
Emerson Laurentino
π» π β οΈ
Leonardo Dutra
π» π β οΈ
Victor MagalhΓ£es
π» π§
Amauri Dias
π» π§
Felipe F. Diogo
π» β οΈ
Alan Raso
π» β οΈ
Felipe Fetter
π
Rafael Franco
π» π
Rafael Pezzetti
π» β οΈ π
Antonio Roberto Furlaneto
π» π β οΈ
Felipe Nolleto Nascimento
π» π β οΈ
Saulo Joab
π
Pedro Arantes
π» π β οΈ
Silvio ClΓ©cio
π» π β οΈ
Lucas Nascimento
π»
Lincon Kusunoki
π» π β οΈ
Marcelo Cristiano
π» π β οΈ
TarcΓsio Batista de Freitas Junior
π
Lucas Carrias
π β οΈ π» π§
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome!
## License
[MIT](LICENSE)