lucasbarzan/gofinances

💰 App web para registro de transações de entrada/saída com valor e categoria 📝

💰 GoFinances

💰 App web para registro de transações de entrada/saída com valor e categoria. 📝

Concluído 🚀

Tabela de conteúdos

• Sobre o projeto
• Funcionalidades
• Layout
  • Web
• Como executar o projeto
  • Pré-requisitos
  • Rodando o Backend (servidor)
  • Rodando a aplicação web (Frontend)
• Tecnologias
  • Website
  • Server
  • Utilitários
• Como contribuir no projeto
• Autor
• Licença

💻 Sobre o projeto

💰 O GoFinances armazena transações financeiras de entrada e saída e permite o cadastro e a listagem dessas transações, além da criação de novos registros no banco de dados a partir do envio de um arquivo csv.

Projeto desenvolvido durante o bootcamp GoStack oferecido pela Rocketseat.

---

⚙️ Funcionalidades

• O usuário pode cadastrar transações
• O usuário pode listar transações
• O usuário pode exibir o balanço (diferença entre entradas e saídas)
• O usuário pode importar transações a partir de um arquivo csv

---

🎨 Layout

O layout da aplicação está disponível no Figma:

Web

---

🚀 Como executar o projeto

Este projeto é divido em duas partes:

1. Backend (pasta server)
2. Frontend (pasta web)

💡 O Frontend precisa que o Backend esteja sendo executado para funcionar.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode.

🎲 Rodando o Backend (servidor)

# Clone este repositório
$ git clone git@github.com:lucasbarzan/gofinances.git

# Acesse a pasta do projeto no terminal/cmd
$ cd gofinances

# Vá para a pasta server
$ cd server

# Instale as dependências
$ npm install

# A aplicação utiliza banco de dados Postgres. Caso não tenha um ainda, recomendo criar um container postgres usando o Docker.
# Com o Docker instalado e rodando, execute o comando abaixo para criar o container "gostack-postgres"
docker run --name gostack-postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

# As demais configurações da conexão com o banco de dados estão no arquivo ormconfig.json dentro da pasta server
# Você pode modificar o host (trocando pra "localhost", por exemplo), porta, nome do banco, etc.

# Execute a aplicação em modo de desenvolvimento
$ npm run dev:server

# O servidor inciará na porta:3333 - acesse http://localhost:3333 

🧭 Rodando a aplicação web (Frontend)

# Clone este repositório
$ git clone git@github.com:lucasbarzan/gofinances.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd gofinances

# Vá para a pasta da aplicação Front End
$ cd web

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run start

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• EditorConfig
• ESLint
• Prettier

Website (React + TypeScript)

• React Router Dom
• Styled Components
• Polished
• Axios
• React Dropzone

Veja o arquivo package.json

Server (NodeJS + TypeScript)

• Express
• CORS
• node-postgres
• TypeORM
• ts-node
• dotENV
• Multer
• Jest

Veja o arquivo package.json

Utilitários

• Protótipo: Figma
• Editor: Visual Studio Code
• Teste de API: Insomnia
• Fontes: Poppins

---

💪 Como contribuir no projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

---

🦸 Autor

_{Lucas Barzan}

---

📝 Licença

Este projeto esta sob a licença MIT.

Feito com ❤️ por Lucas Barzan 👋🏽 Entre em contato!