Skip to content

A RentUP API foi desenvolvida para resolver os desafios de gerenciamento de estoque e empréstimos em laboratórios maker.

License

Notifications You must be signed in to change notification settings

LucasGdBS/RentUP

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

size Server Ok License

rentup-logo

💡 De onde surgiu ?

Bem vindo a mais um produto do grupo BeeHive, grupo de estudantes da faculdade CESAR School, desenvolvedores e entusiastas de tecnologia e inovação. Contando brevemente a historia desse projeto:

Nessa oportunidade tivemos o prazer de trabalhar juntamente ao Garagino (Grupo de estudo cientifico dos alunos da CESAR), que chegaram ao nosso grupo com uma problematica bem clara:

  • A falta de um sistema que os ajudasse a monitorar os equipamentos do laboratório.
  • A falta de controle dos empréstimos que são realizados pelo laboratório, atualmente isso é feito de uma forma muito desestruturada.

A partir de encontros com responsáveis pelo Garagino nós imergimos no problema para vir com a melhor solução para eles, e após todo processo nós criamos o RentUp.

🤔 O que é o RentUP?

O RentUP é uma API para gerenciamento de estoque, usuários e empréstimos para laboratórios maker

Oferecendo:

  • Sistema de permissões para usuários
  • Sistema de autorização, acompanhamento e controle de empréstimos
  • Controle e acompanhamento de estoque em tempo real
  • Inferencia de dados, auxiliando o gerente do lab na tomada de decisões

🦄 Por que usar o RentUP?

Agora você me pergunta, qual vantagem que eu, como cliente, teria em usar o produto RentUp?

A resposta é bem simples: por ser uma API, a flexibilidade e escalabilidade do produto se diferenciam dos seus concorrentes no mercado.

Tornando qualquer tipo de integração com o front-end desejado, simples e prática de se fazer. Em pouco tempo, é possível se adaptar a qualquer demanda.

Sabe quando é necessário que haja uma mudança ou adaptação no produto já feito? Seja em relação à atualização de uma tecnologia ou até mesmo uma evolução de sistema? A nossa solução cobre exatamente esse problema. Sendo uma API, qualquer tipo de integração com o front-end desejado, é simples e prática de se fazer. Em pouco tempo, é possível se adaptar a qualquer demanda.

Então a pergunta certa seria, Porque não usar?

🧑‍💻 Tecnologias usadas no desenvolvimento

Python PostGreSQL FastAPI vscode

Tecnologia Descriçao Versão
Python Back-end do projeto e contrução da APi
FastAPI Framework usar para criação de API Rest
PostgreSQL Banco de dados utilizado
Alambic Ferramenta usada para migrações do banco de dados
SqlAlchemy ORM utilizado para controle do banco de dados

💻 Utilizando o RentUP

Para garantir o funcionamento e aplicação da API desenvolvida, colocamos ela em funcionamento juntamente ao framework StreamLit, que é uma ferramenta para contrução de interfaces web.

A utilização dessa ferramenta foi realizada devido à agilidade que ela proporciona à equipe.

Segue algumas imagens e gifs do funcionamento dela nessa aplicação, validadando assim seu funcionamento.

Inserir gif e imagem :)

⚙️ Instruções de instalação

  • Linguagem Utilizada
    • Python
    • Utilizamos a versão 3.11.2!

Instalando e configurando o postgreSQL

  1. Instale o PostgreSQL
  2. Faça a instalação normal e coloque a senha se sua escolha. Mas cuidado! Não se esqueça dela
  3. Opcional: Recomendamos que utilize o DBeaver para manipular o banco de dados. Mas caso prefira, não tem problema usar o pgAdmin4, gerenciador padrão do PosgreSQL
  4. No DBeaver clique em "Nova conexão".
    1. Selecione o PostgreSQL e clique em avançar
    2. Se você fez a instalação de forma padrão só precisará colocar sua senha (definida no passo 2) no campo senha
    3. Clique em concluir e sua conexão deve estar funcionando
    4. Clique na setinha ao lado do elefantinho e irá aparecer uma pasta chamada Bancos de Dados. Clique com o botão direito sobre ela e selecione Criar nova Banco de Dados
    5. Preencha o nome do banco de dados como preferir! O nosso se chama RentUP 😁
    6. Agora vamos montar sua string de conexão com o banco! Ficará assim: postgresql+pg8000://postgres:SUASENHA@localhost:5432/NOMEDOSEUBANCODEDADOS . Deixa ela salva, pois vamos precisar jaja
  5. Clone o repositorio do RentUP e abra o projeto no seu VSCode (Ou a IDE que preferir)

Preparando seu ambiente de desenvolvimento (No windows)

  1. Crie seu ambiente virtual
python -m venv venv
  1. Ative seu ambiente virtual
.\venv\Scripts\activate
  1. Instale todas as dependências do projeto
pip install -r requirements
  1. Quase tudo pronto! Crie um arquivo no diretório do projeto chamado .env e nele você vai colocar o seguinte:
CONNECT= --- AQUI VOCÊ COLOCA A STRING DE CONEXÃO FEITA NO PASSO 4.6 ---
SECRET_KEY= --- AQUI VOCÊ COLOCA UMA RANDOM HEX KEY ---
ALGORITHM=HS256

Pode gerar a Random Hex Key nesse site aqui

  1. Ufa! Tudo pronto! Agora basta executar esses 2 comandos (um de cada vez) para rodar o projeto!
alembic upgrade head
uvicorn api.main:app --reload

Mais detalhes - Google Sites

Desenvolvido por:

About

A RentUP API foi desenvolvida para resolver os desafios de gerenciamento de estoque e empréstimos em laboratórios maker.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.1%
  • Other 0.9%