Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ruymon/piggy
Piggy 🐷 - Seu Porquinho Digital
https://github.com/ruymon/piggy
finance nextjs piggy pwa react typescript
Last synced: about 6 hours ago
JSON representation
Piggy 🐷 - Seu Porquinho Digital
- Host: GitHub
- URL: https://github.com/ruymon/piggy
- Owner: ruymon
- License: mit
- Created: 2021-07-12T18:13:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-16T13:21:45.000Z (about 2 years ago)
- Last Synced: 2023-03-05T10:34:14.525Z (almost 2 years ago)
- Topics: finance, nextjs, piggy, pwa, react, typescript
- Language: TypeScript
- Homepage:
- Size: 869 KB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Seu Porquinho Digital 🐷
Gerencie seu dinheiro de forma simples e fácil, enquanto aprende!
---
Instalando e Rodando |
Como Contribuir ? |
Licença
## :memo: Stack
- [x] Next.JS - *Used for SEO and SSR*
- [x] React.JS - *Front-end Framework*
- [x] Typecript
- [x] Google Workbox - *PWA*
- [x] Jest - *Testing*
- [x] Figma - *UI Design*
## 🚀 Instalando e Rodando
_Aviso: Caso esteja com dúvidas sobre como clonar veja esse [tutorial aqui](https://help.github.com/pt/github/creating-cloning-and-archiving-repositories/cloning-a-repository), 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:
```cmd
git clone https://github.com/ruymon/piggy
```
4. Entre na pasta rodando pelo terminal:
```cmd
cd piggy
```
5. Após a instalação do repositório, você deve instalar as dependências do projeto. **Para isso rode o comando**:
```cmd
yarn install
```
ou, caso utilize **npm**
```cmd
npm install
```
6. Para iniciar o servidor de desenvolvimento, **rode o comando:**
```cmd
yarn start
```
ou, caso utilize **npm**
```cmd
npm start
```
## 🤔 Como Contribuir
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](https://help.github.com/pt/github/getting-started-with-github/fork-a-repo) 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
git checkout -b minha-alteracao
```
- [ ] Faça as alterações.
- [ ] Faça *commit* das suas alterações:
```cmd
git commit -m 'feat: Minha nova feature'
```
- [ ] Faça um *push* das alteraçoes para a sua *branch*:
```cmd
git push origin minha-alteracao
```
:tada: 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*.
## :memo: Licença
MIT © [Ruy Monteiro](https://github.com/ruymon). Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
---
Feito com ♥ by [Ruy Monteiro](https://github.com/ruymon) :wave: