thaimedeiros / apirest-nodejs

Uma API Request em node.js para cadastro de produtos.

API Request em Node.js

• Uma API Request em node.js para cadastro de produtos.

📰 Features  |   📌 Pré-requisitos  |   💻 Tecnologias  |   ▶️ Rodando o Projeto  |   🧩 Como Contribuir  |   📝 Licença

📰 Features

• Usuários:
  • Cadastrar;
  • Deletar;
  • Realiza Login;
  • Visualizar.
• Categorias:
  • Atualizar;
  • Cadastrar;
  • Deletar;
  • Exibir;
  • Visualizar.
• Produtos:
  • Atualizar;
  • Cadastrar;
  • Deletar;
  • Exibir;
  • Visualizar.
• Pedidos:
  • Cadastrar;
  • Deletar;
  • Exibir;
  • Visualizar.

📌 Pré-requisitos

• Git
• Laragon ou XAMPP
• MySQL
• Node.JS
• Npm
• Postman
• VSCode

💻 Tecnologias

• Esse projeto foi desenvolvido com as seguintes tecnologias:
  • JavaScript;
  • MySQL;
  • Node.JS.

▶️ Rodando o Projeto

Siga os seguintes passos para instalar:

# clonando o projeto na sua maquina
$ git clone https://github.com/ThaiMedeiros/apirest-nodejs.git

# entre na pasta do projeto
$ cd apirest-nodejs

# instale as dependências através do comando:
$ `npm install`

# execute seu servidor de banco de dados MySQL
$ execute o **laragon** ou **xampp** (ou outro servidor web)

# logo após a inicialização, acesse no browser:
$ http://localhost://phpmyadmin (então crie um novo banco de dados)

# crie um banco de dados chamado:
$ testeapi

# após a criação, importe o arquivo que está na pasta:
$ banco_de_dados

# para rodar a aplicação, vá novamente a raiz e digite o seguinte comando:
$ `npm start`

# após a aplicação rodando, recomendo utilizar o >> Postman << para fazer as requisições.
# dentro da pasta: >> collection_postman <<, estão todas as requisições da API configuradas.

# poderá acessá-lo através do endereço:
$ `localhost:3000`

Observações:

• Caso a pasta de upload não exista, crie-a na raiz.
• Após importar a collection no postman, caso a variável url esteja sem o valor padrão: (localhost:3000), siga os seguintes passos:
  • (essas configurações são opcionais)

1. Passe o mouse em cima, e clique nos 3 (...) ao lado do nome e vá na opção: Edit
2. Logo após, no menu superior, clique na opção: Variables
3. Em variables, crie uma chamada: url e no initial value e em current value insira: localhost:3000 ou a localização da url padrão onde você está executando a aplicação.
4. Pronto, suas variáveis de ambiente estão criadas. Isso poupa-lhes tempo de ficar digitando a url inteira, além de viualmente deixá-la mais "enxuta", já que algumas são grandes.

🧩 Como Contribuir

1. Faça um fork desse projeto.
2. Crie uma nova branch para trabalhar: git checkout -b my-feature
3. Faça commit da sua feature: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature
5. Solicite uma Pull Request para o diretório original.

📝 Licença

Esse projeto está sob a licença ⚖️ MIT License. Veja o arquivo LICENSE para mais detalhes.

---

Desenvolvido por: ©️ Thaiza Medeiros 👩‍💻 💜