ruymon / piggy Goto Github PK

Seu Porquinho Digital 🐷
Gerencie seu dinheiro de forma simples e fácil, enquanto aprende!

Instalando e Rodando   |    Como Contribuir ?   |    Licença

• Next.JS - Used for SEO and SSR
• React.JS - Front-end Framework
• Typecript
• Google Workbox - PWA
• Jest - Testing
• Figma - UI Design

Aviso: Caso esteja com dúvidas sobre como clonar veja esse tutorial aqui, vai te ajudar 😁

1. Abra o terminal do seu computador.

2. Escolha o diretório 💡 Dica: (Utilize os comandos cd e ls).

3. Clone o Repositório rodando:
   

git clone https://github.com/ruymon/piggy

4. Entre na pasta rodando pelo terminal:

cd piggy

5. Após a instalação do repositório, você deve instalar as dependências do projeto. Para isso rode o comando:

yarn install

ou, caso utilize npm

npm install

6. Para iniciar o servidor de desenvolvimento, rode o comando:

yarn start

ou, caso utilize npm

npm start

Caso queira contribuir com o 🐷Piggy, seja com: Bug Fixes; Melhorando a Documentação; Melhorias na Arquitetura da Aplicação ou qualquer aperfeiçoamento da Aplicação, você pode seguir o tutorial abaixo:

• Faça um fork desse repositório;

• Entre no seu perfil do GitHub e faça um clone do repositório que você fez um fork.

• Crie uma nova branch com a sua alteração. 💡 Dica: Para criar uma nova Branch utize o comando:

git checkout -b minha-alteracao

• Faça as alterações.

• Faça commit das suas alterações:

git commit -m 'feat: Minha nova feature'

• Faça um push das alteraçoes para a sua branch:

git push origin minha-alteracao

🎉 Tcharam! Agora é só abrir a sua pull request no repositório que você fez o fork;

⚠ Lembrete: Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

MIT © Ruy Monteiro. Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Feito com ♥ by Ruy Monteiro 👋