https://github.com/devhatt/pet-dex-frontend
https://github.com/devhatt/pet-dex-frontend
css diogojs frontend html javascript opensource
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/devhatt/pet-dex-frontend
- Owner: devhatt
- Created: 2023-11-28T19:17:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T14:18:24.000Z (almost 2 years ago)
- Last Synced: 2024-09-17T17:38:06.810Z (almost 2 years ago)
- Topics: css, diogojs, frontend, html, javascript, opensource
- Language: JavaScript
- Homepage:
- Size: 3.71 MB
- Stars: 34
- Watchers: 4
- Forks: 45
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# PetDex Project
[](https://www.typescriptlang.org/)
[](https://www.postgresql.org/)
[](https://www.docker.com/)
[](https://developer.mozilla.org/pt-BR/docs/Web/JavaScript)
[](https://developer.mozilla.org/pt-BR/docs/Web/HTML)
[](https://sass-lang.com/)
[](https://jestjs.io/)
[](https://github.com/devhatt/pet-dex-frontend/contributors)
[](https://github.com/devhatt/pet-dex-frontend/stargazers/)
[](http://discord.gg/3gsMAEumEd)
[](https://twitter.com/DevHatt)
--
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](https://github.com/devhatt/pet-dex-backend).
## **Introdução**
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.
## **Primeiros Passos**
Para começar no PetDex, siga estes passos:
1. Clonar o repositório: **`git clone https://github.com/devhatt/pet-dex-frontend.git`**
2. Entrar na pasta do projeto: **`cd pet-dex-frontend`**
3. Instalar as dependências: **`pnpm install`**
4. Iniciar o aplicativo: **`pnpm dev`**
5. Instalar as extensões:
- **`ESLint`**
- **`Stylelint`**
- **`Prettier`**
## **Contribuição**
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!
1. **Desenvolvimento:**
- Faça um fork do repositório e trabalhe em novas funcionalidades.
- Resolva problemas existentes ou proponha melhorias.
2. **Documentação:**
- Aprimore a documentação existente ou crie tutoriais para ajudar outros desenvolvedores.
3. **Testes:**
- Ajude a garantir a estabilidade do aplicativo testando as novas funcionalidades e relatar problemas.
## **Cargos**
Em nosso [servidor do discord](http://discord.gg/3gsMAEumEd), 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.
## **Código de Conduta**
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](https://github.com/Alecell/octopost/blob/master/CODE_OF_CONDUCT.md)**.
## **Contato**
Se tiver alguma dúvida ou precisar de ajuda, fique à vontade para entrar em contato com nossa equipe em nosso [Discord](http://discord.gg/3gsMAEumEd).
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.