https://github.com/naveteam/prometheus

Repositório de hooks da Nave.rs
https://github.com/naveteam/prometheus

Last synced: about 14 hours ago
JSON representation

Repositório de hooks da Nave.rs

• Host: GitHub
• URL: https://github.com/naveteam/prometheus
• Owner: naveteam
• License: mit
• Created: 2020-07-12T18:15:13.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2020-07-31T16:07:39.000Z (over 4 years ago)
• Last Synced: 2024-11-02T00:36:14.516Z (17 days ago)
• Language: JavaScript
• Homepage: https://naveteam.github.io/prometheus/
• Size: 3.52 MB
• Stars: 7
• Watchers: 23
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![Prometheus](https://github.com/naveteam/prometheus/blob/assets/header.png?raw=true)

Repositório de hooks da Nave.rs


![stability-wip](https://img.shields.io/badge/stability-work_in_progress-lightgrey.svg)

[![NPM](https://img.shields.io/npm/v/@naveteam/prometheus.svg)](https://www.npmjs.com/package/@naveteam/prometheus)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

![ci](https://github.com/naveteam/prometheus/workflows/ci/badge.svg)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

## 🛠 Tecnologias utilizadas

Baseamos nosso desenvolvimento em:

- [React](https://reactjs.org/)

- [Storybook](https://github.com/storybooks/storybook)

## 🚀 Instalação

No terminal, execute

```shell

yarn add @naveteam/prometheus

// ou npm install @naveteam/prometheus

```

## 💡 Utilização

Com a lib instalada, o seguinte código já é o suficiente para iniciar o desenvolvimento da aplicação

```jsx

import React, { useState } from 'react'

import ReactDOM from 'react-dom'

import { useDebounce } from '@naveteam/prometheus'

const App = () => {

  const [organicValue, setOrganicValue] = useState(null)

  const debouncedValue = useDebounce(organicValue)

  return (

    


       setOrganicValue(e.target.value)} />

      
{debouncedValue}

    

  )

}


ReactDOM.render(, document.getElementById('root'))

```

Você pode encontrar em nosso [Storybook](https://naveteam.github.io/prometheus) a documentação necessária de todos os hooks disponíveis no projeto.

## 🤝 Contribuição

Sinta-se livre para contribuir com o projeto, criando novos hooks, abrindo PRs para ajustar bugs ou mesmo levantando dúvidas, sugestões ou pedidos de ajustes através de issues. Para contribuir com nosso projeto, por favor siga nosso guia de [CONTRIBUTING](CONTRIBUTING.md).

## 📚 Links úteis

- [NPM](https://www.npmjs.com/package/@naveteam/prometheus): Acesso ao pacote NPM do projeto

- [Github](https://github.com/naveteam/prometheus): Repositório da lib

- [Storybook](https://naveteam.github.io/prometheus): Página com o projeto mais atualizado para referência

## Contribuidores ✨

Obrigado a essas maravilhosas pessoas que contribuíram de alguma maneira para o desenvolvimento da lib ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Eduardo Bittencourt
💻 🤔 🚧 👀 🐛 📖 💡 🚇

    
Lucas Barbosa
💻 📖

    
Rafael Candia
👀

  

Esse projeto segue a especificação de [all-contributors](https://github.com/all-contributors/all-contributors). Qualquer tipo de contribuição será bem-vinda!

## Licença

MIT © [Nave Team](https://github.com/naveteam)