Bem-vindo ao PetDex, este documento README irá guiá-lo através das informações básicas sobre o projeto, seu propósito e como contribuir de forma eficaz. Esse projeto está separado em 2 repositórios, para visualizar o repositório do back-end clique aqui.
O PetDex é um projeto mobile/desktop com o objetivo de facilitar a adoção de pets. No petdéx usuários e ONGs podem cadastrar os animais para adoção e o aplicativo vai fazer um sistema de match com o usuário que mais combina com aquele pet.
Para começar no PetDex, siga estes passos:
- Clonar o repositório:
git clone https://github.com/devhatt/pet-dex-frontend.git
- Entrar na pasta do projeto:
cd pet-dex-frontend
- Instalar as dependências:
pnpm install
- Iniciar o aplicativo:
pnpm dev
- Instalar as extensões:
ESLint
Stylelint
Prettier
Se você é um entusiasta de pets, desenvolvedor em ascensão ou simplesmente quer fazer parte da comunidade PetDex, aqui estão algumas maneiras de contribuir: Recebemos contribuições da comunidade para tornar o PetDex ainda melhor!
- Desenvolvimento:
- Faça um fork do repositório e trabalhe em novas funcionalidades.
- Resolva problemas existentes ou proponha melhorias.
- Documentação:
- Aprimore a documentação existente ou crie tutoriais para ajudar outros desenvolvedores.
- Testes:
- Ajude a garantir a estabilidade do aplicativo testando as novas funcionalidades e relatar problemas.
Em nosso servidor do discord, temos várias opções de cargos, que você poderá adquirir participando do servidor e subindo de level, contribuindo com o projeto.
Distribuição dos cargos
Pet Dex
→ Entrar no servidor e pegar o cargo;Torttinho
→ User que participa minimamente do servidor;Hattinho
→ Participante ativo do servidor, está contribuindo no projeto e pegando tasks;De capa
→ Dev com experiência, já trabalha na área e está ajudando e participando do projeto;Hatter
→ Participante aprovado na seleção feita pelo Alecell e está envolvido ativamente no projeto;Bolha
→ Dev influente e conhecido da bolha dev e participa do servidor;Dono do parquinho
→ Auto-explicativo. Idealizador do projeto e com poderes especiais.
O PetDex segue um Código de Conduta para garantir um ambiente respeitoso e inclusivo para todos os contribuidores. Leia e entenda o nosso Código de Conduta.
Se tiver alguma dúvida ou precisar de ajuda, fique à vontade para entrar em contato com nossa equipe em nosso Discord.
Obrigado pelo seu interesse no PetDex! Esperamos suas contribuições e esperamos que você aproveite o aplicativo tanto quanto nós gostamos de construí-lo.