rsmelo / pilot

:airplane: The next iteration of Pagar.me's Dashboard

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pilot

A próxima versão da Dashboard Pagar.me


Join the chat at https://gitter.im/pagarme/react-event-components

Pilot é o codinome da nova dashboard do Pagar.me. O produto foi criado a partir de feedbacks dos usuários, para que eles possam ter uma experiência cada vez mais transparente de sua operação financeira no Pagar.me, e consigam focar no seu negócio!

Trabalhando neste repositório

Este repositório é um monorepo que aloja os pacotes que compõem o Pilot. Para instalar as dependências é necessário usar o Yarn versão 1.0 ou superior, que suporta a funcionalidade de Workspaces.

Stack

A stack foi escolhida com base no que empresas como Facebook, AirBnb, e New York Times estão usando para construir suas experiências. Também foi levado em consideração a simplicidade, curva de aprendizado e requisitos como fácil distribuição e entrega progressiva.

Tendo isso em vista, fomos de React. A estrutura do projeto foi iniciada rapidamente usando o FormerKit Dashboard, projeto que desenvolvemos baseado no Create React App para nos permitir criar rapidamente projetos de dashboards.

Rodando

Use o Yarn para instalar as dependências:

yarn

Entre no diretório do Pilot:

cd packages/pilot

Inicie a aplicação:

yarn start

Contribuindo

Caso queira fazer uma contribuição grande, recomendamos que abra uma issue para discutir sua ideia antes de executá-la. Para pequenos bugfixes fique a vontade para abrir PRs. Fique atento aos padrões de projeto que usamos -- veja nosso styleguide de React e CSS e também nosso [Git Style Guide][git-styleguide].

Usamos o Github flow no desenvolvimento. Para criar um novo PR:

  1. Crie um fork deste repositório e clone em seu computador
  2. Crie uma nova branch baseada na master (git checkout -b fix/button-size por exemplo)
  3. Faça suas alterações, criando commits que agrupam as alterações feitas
  4. Envie sua branch para seu fork (git push origin fix/button-size, por exemplo)

Caso sua branch fique desatualizada, poderemos solicitar um rebase. Para fazê-lo:

  1. Adicione nosso "upstream" como remoto: git remote add upstream https://github.com/pagarme/pilot
  2. Busque as atualizações do upstream: git fetch upstream
  3. Faça o rebase de sua branch: git rebase upstream/master <sua-branch>
  4. Resolva os conflitos e use git rebase --continue para continuar
  5. Faça o force push em seu fork: git push origin <sua-branch> --force-with-lease

Licensing

See LICENSES.


About

:airplane: The next iteration of Pagar.me's Dashboard


Languages

Language:JavaScript 96.1%Language:CSS 2.8%Language:HTML 1.1%