opencollective frontend

Frontend coletivo aberto

Prefácio

Se você vir uma etapa abaixo que pode ser melhorada (ou está desatualizada), atualize as instruções. Raramente passamos por esse processo, então seu novo par de olhos e sua experiência recente com ele fazem de você o melhor candidato para melhorá -los para outros usuários. Obrigado!

Desenvolvimento

Pré -requisito

1. Verifique se você tem Node.js versão 20.x e NPM Versão> = 9.0.0.

• Recomendamos o uso de NVM: nvm install && nvm use .

Instalar

Recomendamos clonar o repositório em uma pasta dedicada a projetos opencollective .

 git clone [email protected]:opencollective/opencollective-frontend.git opencollective/frontend
cd opencollective/frontend
npm install

Variáveis de ambiente

Este projeto requer um acesso à API coletiva aberta.

Por padrão, ele tentará se conectar à API de preparação coletiva aberta, você não precisa mudar nada .

Caso você queira se conectar à API coletiva aberta em execução localmente:

• Clone, instale e inicie o OpenCollective-api
• Neste projeto, copie o seguinte conteúdo para um arquivo .env :

 API_URL=http://localhost:3060
API_KEY=dvl-1510egmf4a23d80342403fb599qd

Começar

 npm run dev

Testes

Para executar os testes:

• Para páginas e componentes, use npm test
• Para testes de ponta a ponta (E2E) usando o CYPRESS, consulte nosso guia dedicado.

Para atualizar:

• JEST Snapshots: Execute npm run test:update
• Arquivos de tradução: Execute npm run langs:update
• Esquema GraphQL para ESLint: Execute npm run graphql:update

Styleguide

Usamos o Storybook para desenvolver e documentar nossos componentes do React isoladamente com componentes com estilo e sistema de estilo.

Mais informações: docs/styleguide.md

Localização

Traduzir a interface não requer nenhuma habilidade técnica, você pode acessar https://crowdin.com/project/opencollective e começar a traduzir imediatamente!

Atualmente, estamos procurando contribuições para os seguintes idiomas:

• Francês
• Espanhol
• japonês

Quer adicionar um novo idioma para o Open Collective? Entre em contato conosco e ficaremos felizes em ajudá -lo a configurá -lo!

Contribuindo

Estilo de código? Convenção cometer? Por favor, verifique nossas diretrizes contribuintes.

TL; DR: Usamos mais bonito e Eslint, gostamos de ótimas mensagens de compromisso e do histórico de Git limpo.

Recompensas

Este repositório faz parte do programa de recompensa coletiva aberta. Seja pago para contribuir para o código aberto! A equipe de engenharia coletiva aberta é pequena e estamos sempre procurando novos colaboradores de nossas bases de código de código aberto. Nosso programa de recompensa é uma oportunidade de resolver questões que poderiam ser negligenciadas de outra forma. Os colaboradores que corrigem esses problemas serão recompensados financeiramente. Consulte nossos documentos para obter mais informações: https://docs.opencollective.com/help/contributing/development/bounties

Implantação

Atualmente, este projeto está implantado para encenação e produção com a Heroku. Para implantar, você precisa ser um membro central da equipe coletiva aberta.

Mais informações: docs/implantment.md

Componentes de publicação

Para publicar uma atualização de componentes de front -end para o NPM, você precisa ser um membro central da equipe coletiva aberta. Passos:

1. Verifique a versão atualmente publicada com npm view @opencollective/frontend-components version
2. Acionar o script de publicação executando npm run publish-components {NEW_VERSION} , onde {NEW_VERSION} é o novo número da versão (siga o semver).
3. Revise as alterações e confirme se tudo faz sentido.

Para adicionar novos arquivos ou dependências a este pacote exportado, dê uma olhada nos scripts/publish-components/config.ts.

Discussão

Se você tiver alguma dúvida, ping -nos no Discord ou no Twitter (@Opencollect).

Obrigado

Agradecemos ao Lost Pixel por fornecer a plataforma de teste visual que nos ajuda a revisar as mudanças na interface do usuário e a capturar regressões visuais.