/hackdoagora-backend

Primary LanguageJavaScriptMIT LicenseMIT

Provi hack do Agora

Troca Inteligente

Equipe 42

Tópicos

=================

Repositórios

Deploy da aplicação

Sobre o projeto

A Troca Inteligente, trata-se de uma lixeira que gerencia os resíduos pós consumo e garante benefícios em pontos para que você descarte os resíduos corretamente.

Como iniciar o projeto:

  • Clone este repositório em sua máquina
 $ git clone https://github.com/gbr-mendes/hackdoagora-backend.git

Instalação:

Node.JS

  • Para inicializar o projeto precisamos do Node.JS instalado na máquina, entre nesse link e baixe a versão LTS referente ao seu sistema operacional.
  • Quando terminar a instalação, abra o terminal do seu computador e digite os comandos abaixos:
node -v
npm -v
  • Se ambos os comandos acima imprimirem as versões do node e npm respectivamente, você esta pronto para seguir
  • Entre na pasta no diretório que você clonou e execulte o comando abaixo.
npm install

  • Crie um arquivo .env na raiz do projeto e inclua as seguintes informações:

    • CLOUDINARY_NAME=string
    • CLOUDINARY_API_KEY=string
    • CLOUDINARY_API_SECRET=string
    • TOKEN_SECRET=string Necessário para geração de jwt
    • HOST=localhost:3000

  • Faça cadastro na cloudinary para obter as informações acima

  • Você também pode incluir a seguinte variável de ambiente para usar uma base de dados na nuvem como no atlas, caso contrário precisará ter o mongodb instalado na sua máquina:

    • DB_URI=string

  • Com isso setado, execute os comandos abaixo:

npm run swagger auto-gen
npm run devStart

  • Acesse a url e veja a documentação da api

  • ATENÇÃO. Para a api funcionar localmente, é necessário que você tenha ao menos um Reciclável e uma lixeira cadastrados no banco de dados. A rota de criação da lixeira é reservada a usuários admin, mas foi liberada para propósitos de teste.Você pode fazer a adição pelo swagger.Após a adição dos items divirta-se

Tecnologias

No desenvolvimento do projeto, utilizamos as seguintes tecnologias e ferramentas:

  • Desenvolvimento Front-End: HTML, CSS, Nextjs, ChakraUI;
  • Desenvolvimento Back-End: Nodejs e Express;
  • Banco de dados: MongoDB;
  • Gerenciamento de Media: Cloudinary
  • Ux Design: Figma;

Vídeos de apresentação

Equipe:

  • Eliezer Perez - Desenvolvedor Full Stack

  • Gabriel Silva - Desenvolvedor Back-end

  • Alexssandra Pimentel - Desenvolvedora Back-end

  • Luciano Ferreira - Desenvolvedor Front-end

  • Bianca Medrado - Product Owner

  • Audrey Doanne - Ux Designer