📝 Papelaria da Lu

Introdução

Projeto final desenvolvido como requisito parcial para aprovação no programa de aceleração em Node.js Luiza Code 4ª edição.

O desafio proposto foi o de desenvolver um módulo de lista de desejos dos produtos de um e-commerce de itens de papelaria para seus clientes.

🎯 Features

• Gerenciamento de clientes
• Gerenciamento de produtos
• Gerenciamento de listas de desejos

🎬 Demonstração em Vídeo

O vídeo abaixo demonstra as principais funcionalidades da API através de requisições realizadas com o ThunderClient, uma extensão para VS Code.

demostracaoProjetoLuizaCodeFinal.mp4

📖 Guia de instalação

Clone este repositório utilizando o comando:

git clone https://github.com/LuizaCode4ed-Grupo1/PapelariaDaLu.git

Instale as dependências:

npm install

Você deve criar um arquivo .env na raiz do projeto, com o conteúdo:

DB_USERNAME=beatrizmakowski
DB_PASSWORD=995679

🚀 Inicializando

Para inicializar o servidor, utilize o comando:

npm start

Conecte na API utilizando a porta 3000.

💻 Banco de Dados e Coleções MongoDB

• clientes
• listasdesejos
• produtos

Comando para a criação do banco de dados com a coleção clientes

const database = 'papelaria-da-lu';
const collection = 'clientes';
use(database);
db.createCollection(collection);

Comando exemplo para a criação das demais coleções do banco de dados

use('papelaria-da-lu');
db.createCollection('produtos');

🚩 API Endpoints

Todos os endpoints foram documentados com o swagger, que pode ser acessado através do link: http://localhost:3000/docs/

🖥️ Tecnologias utilizadas

• NodeJS - Node.js é um software de código aberto, multiplataforma, baseado no interpretador V8 do Google e que permite a execução de códigos JavaScript fora de um navegador web.
• ExpressJS - Express é um dos mais populares frameworks para servidores Node.js.
• MongoDB - MongoDB é um programa de banco de dados NoSQL, de código aberto e multiplataforma, que fornece escalabilidade e flexibilidade.
• Mongoose - Mongoose é uma biblioteca do Node.js que proporciona uma solução baseada em esquemas para modelar os dados da uma aplicação.
• Swagger - Swagger é um framework com um conjunto de ferramentas para desenvolvedores de API da SmartBear que independente da linguagem, auxilia a descrição, consumo e visualização de serviços de uma API REST através da criação de sua documentação.

👩‍💻 Autoras

Aline Viana 😉

Beatriz Makowski 🤓

Jéssica Troiano 😸

Mariana Dorigan 🤖

Priscilla Rarimmy 👾