yourFinance

Tópicos

• Sobre o yourFinance
• Tecnologias
• Pré requisitos
• Rodando a aplicação
• Executando os testes
• Colaborando
• Licença
• Colaboradores

💰 Sobre o yourFinance

O yourFinance é um software para gerenciamento e controle de finanças pessoais!

O projeto foi desenvolvido com o intuito de eliminar a utilização de planilhas para gerenciamento de controle financeiro. Com o armazenamento das informações através de transações, que são chamadas de movs, e podem ser definidas através de categorias, modalidades e tipo. A partir das definições do usuário, o projeto apresenta algumas informações em tela, e realiza determinadas análises da usabilidade do usuário.

🛠️ Tecnologias

Tecnologias e ferramentas utilizadas no desenvolvimento do projeto:

API ( NodeJS + TypeScript )

• Express
• bcryptjs
• jsonwebtoken
• Prisma
• Postgres SQL

Utilitários

• Editor: Visual Studio Code → Extensions: Prettier + EditorConfig
• Versionamento: Git
• Padronização de código: ESLint

📋 Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
→ Git;
→ Node.js;
→ Docker;

🎲 Rodando a aplicação

# Clone este repositório
$ git clone https://github.com/yourFinanceApp/api.git

# Vá para a pasta da aplicação Back end
$ cd api

# Instale as dependências
$ yarn install

Após a instalação das dependências, utilize o comando abaixo para criar o container na porta 5432.

docker run --name yourfinance -e POSTGRES_USER=root -e POSTGRES_PASSWORD=root -p 5432:5432 -d postgres

Adicione na raiz do projeto um arquivo .env com as seguintes configurações.

DATABASE_URL="postgresql://root:root@localhost:5432/yourfinance?schema=public"

Logo após, você já pode rodar a aplicação com os comandos abaixo.

# Crie todas as migrations e seed no banco
$ yarn migrations

# Rode a aplicação
$ yarn dev

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

⚙️ Executando os testes

Explicar como executar os testes automatizados para este sistema.

🔩 Analise os testes de ponta a ponta

Explique que eles verificam esses testes e porquê.

Dar exemplos

💭 Colaborando

Por favor, leia o COLABORACAO.md para obter detalhes sobre o nosso código de conduta e o processo para nos enviar pedidos de solicitação.

📌 Versão

Nós usamos SemVer para controle de versão. Para as versões disponíveis, observe as tags neste repositório.

📄 Licença

Este projeto está sob a licença MIT - veja o arquivo LICENSE.md para detalhes.

🤝 Colaboradores

Agradecemos às seguintes pessoas que contribuíram para este projeto:

Vitor Sousa

João Lucas