Serviço para controle de finanças

Projeto   |    Tecnologias   |    Instalação, execução e desenvolvimento   |    Como contribuir   |    Licença

👨🏻‍💻 Projeto

O GoFinances é uma aplicação completa (API REST, Web e Mobile) voltada para você que deseja realizar o controle manual de seus gastos. Tendo suporte ao o envio de arquivos CSV (Comma-separated values), facilitando a inserção em massa de dados.

🚀 Tecnologias

Esta aplicação foi desenolvida com as seguintes tecnologias:

• Node.js
• ReactJS
• React Native
• TypeScript
• TypeORM
• Express
• PostgreSQL
• Jest
• SuperTest
• React Router DOM
• React Navigation
• React Icons
• Styled Components
• Axios
• Eslint
• Prettier
• EditorConfig

💻 Instalação, execução e desenvolvimento

Pré-requisitos

• Node.js
• Yarn
• PostgreSQL

Faça um clone desse repositório e acesse o diretório

git clone https://github.com/EliasGcf/gofinances.git

Backend

# A partir da raiz do projeto, entre na pasta do backend
$ cd server

# Instale as dependências
$ yarn

# Tenha um banco de dados PostgreSQL em execução, exemplo:
$ docker run --name gofinances-postgres -e POSTGRES_USER=docker -e POSTGRES_PASSWORD=docker -e POSTGRES_DB=gofinances -p 5432:5432 -d postgres

# Execute as migrations
$ yarn typeorm migration:run

# Tudo pronto para iniciar o servidor
$ yarn dev:server

Web

ps: Antes de executar, lembre-se de iniciar o backend deste projeto

# A partir da raiz do projeto, entre na pasta do frontend web
$ cd web

# Instale as dependências
$ yarn

# Tudo pronto para iniciar o client
$ yarn dev:server

Mobile

Ainda em desenvolvimento!

🤔 Como contribuir

• Faça um fork deste repositório

# Fork via GitHub official command line
# Caso não tenha o GitHub CLI, realize o fork pelo site.

$ gh repo fork EliasGcf/gofinances

# Clone o seu fork
$ git clone url-do-seu-fork && cd gofinances

# Crie uma branch com sua feature
$ git checkout -b minha-feature

# Faça o commit das suas alterações
$ git commit -m 'feat: Minha nova feature'

# Faça o push para a sua branch
$ git push origin minha-feature

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

📝 Licença

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

---

Feito com 💜 by EliasGcf