API InvestManager

Sobre • Funcionalidades • Executar • Tecnologias • Contribuidores • Contribuir • Licença

📌 Sobre o Projeto

Bem-vindo ao repositório do Back-end do InvestManager! Aqui, você encontrará uma solução que visa otimizar seus investimentos por meio de um processo inteligente de realocação de ativos. O objetivo do projeto é proporcionar a você uma ferramenta que automatiza o rebalanceamento de sua carteira de investimentos, sem perder horas com cálculos em planilhas, garantindo que sua alocação de ativos esteja sempre alinhada com seus objetivos financeiros e tolerância ao risco. Com algoritmo complexos em cada etapa do simulador de aporte, o projeto oferece uma maneira eficiente de maximizar os retornos de sua carteira, reduzindo o risco e mantendo um portfólio diversificado.

🚀 Funcionalidades

• Autenticação

  • Criar conta
  • Login
  • Cada usuário terá seus próprios ativos, metas, critérios e etc

• Gerenciar ativos

  • Listar ativos - Nome, quanto R$ tem alocado, O % recomendado na carteira e atualmente %
  • Para pegar as precificações atual do ativo é utilizado a API Brapi
  • É utilizado cache REDIS na chamada da API do Brapi, para melhorar o desempenho e não sobrecarregar a api externa
  • Criar ativos - Definindo quantidade, o nome, a classe de ativo, a nota ou as respostas do questionário
  • Editar ativo
  • Deletar ativo

• Definir metas da classe do ativo

  • Definir % que deseja para cada categoria da carteira
  • No máximo a categoria tem que ter até 100%
  • A soma de todas as metas não pode ultrapassar 100%
  • Não pode ter meta negativa

• Definir critérios de analise de ativo

  • Definir perguntas sobre a segurança do ativo para cada categoria
  • Categorias: Ações nacionais e internacionais, FIIS e REITS
  • Essas perguntas são respondidas no cadastro ou edição do ativo
  • Serve para definir o peso e segurança do ativo na carteira

• Definir em quais ativos aportar a partir do valor de aporte

  • É recomendado a partir do valor de aporte o quanto investir em cada ativo
  • É levado em conta o desbalanciamento da classe do ativo em relação a meta
  • Definir quanto investir em cada classe de ativo
  • Com o valor do aporte para cada classe, pegar ativos desbalanciados, com a precificação e nota
  • Definição do valor e quantidade para cada ativo a ser aportado
  • O valor total das recomendações de aporte tem que chegar o mais próximo possivel do valor de aporte

👷 Como executar

Pré-requisitos

1. Ter o Node.js instalado na maquina.
2. Rodar localmente o banco de dados PostgreSQL
3. Rodar localmente o banco de dados Redis

Clonar Repositório

$ git clone https://github.com/Willian17/api-investmanager.git

Configurar

Copiar .env.example para .env na raiz do projeto e definir as variaveis de ambiente (banco de dados e JWT)

Instalar Dependencias

$ npm install

Executar Aplicação

$ npm run start:dev

Utilizar a api de forma visual

Utilizar o FrontEnd do InvestManager

💻 Tecnologias

• NodeJS
• NestJS
• Typeorm
• PostgreSQL
• Redis
• Cache manager

🤝 Contribuidores

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

😄 Seja um dos contribuidores

Contribuições são sempre bem-vindas!

1. Fork o Projeto
2. Criar uma Branch (git checkout -b feature/AmazingFeature)
3. Commit suas alterações (git commit -m 'Add some AmazingFeature)
4. Push na Branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

📝 Licença

Esse projeto está sob licença MIT.

👨‍🚀 Mostre seu apoio

Dê uma ⭐️ se esse projeto te ajudou!