Noderest

Tabela de Conteúdo

• Tabela de Conteúdo
• Sobre o Projeto
  • Feito Com
• Começando
  • Pré-requisitos
  • Estrutura de Arquivos
  • Instalação
  • Rodando a aplicação
• Contribuição
• Contato

Sobre o Projeto

Este projeto visa a criação de uma API REST com NodeJS, Express e MongoDB.

Feito Com

Abaixo segue o que foi utilizado na criação deste projeto:

• Visual Studio Code - O Visual Studio Code é um editor de código-fonte desenvolvido pela Microsoft para Windows, Linux e macOS. Ele inclui suporte para depuração, controle Git incorporado, realce de sintaxe, complementação inteligente de código, snippets e refatoração de código.
• NPM - O npm é um gerenciador de pacotes para a linguagem de programação JavaScript. É o gerenciador de pacotes padrão para o ambiente de tempo de execução JavaScript Node.js.
• Node.js - Node.js é um interpretador de JavaScript assíncrono com código aberto orientado a eventos, criado por Ryan Dahl em 2009, focado em migrar a programação do Javascript do cliente (frontend) para os servidores, criando aplicações de alta escalabilidade (como um servidor web), manipulando milhares de conexões/eventos simultâneas em tempo real numa única máquina física.
• Express - O Express.js, ou simplesmente o Express, é uma estrutura de aplicativo da Web para o Node.js, lançada como software livre e de código aberto sob a Licença MIT. Ele foi projetado para criar aplicativos da Web e APIs. Foi chamado de estrutura de servidor padrão de fato para o Node.js.
• MongoDB - MongoDB é um software de banco de dados orientado a documentos livre, de código aberto e multiplataforma, escrito na linguagem C++. Classificado como um programa de banco de dados NoSQL, o MongoDB usa documentos semelhantes a JSON com esquemas.
• Mongoose - Mongoose é uma ferramenta de modelagem de objeto MongoDB projetada para funcionar em um ambiente assíncrono. Suporta promessas e retornos de chamada. Como também, fornece uma solução direta e baseada em esquema para modelar os dados do aplicativo. Ele inclui conversão de tipo incorporada, validação, criação de consultas, ganchos de lógica de negócios e muito mais, prontos para uso.

Começando

Para conseguir utilizar ou visualizar o projeto, seja através do Visual Studio Code ou outro editor de código, siga os passos abaixo:

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

• Git
• Node.js
• NPM
• VSCode
• MongoDB

Estrutura de Arquivos

A estrutura de arquivos está da seguinte maneira:

noderest
├── bin/  
│   └── server.js
│   src/
│   ├── controllers/
│   │   └── productController.js
│   ├── models/
│   │   └── User.js
│   ├── routes/
│   │   └── index.js
│   │   └── product.js
│   ├── app.js
├── .gitignore
├── package.json
├── package-lock.json
└── README.md

Instalação

• Para instalar esse projeto, o processo é bem simples. Basta utilizar os seguintes comandos no terminal:

# Clone este repositório
$ git clone https://github.com/MTevangelista/noderest.git

# Acesse a pasta do projeto no terminal/cmd
$ cd noderest

# Instale as dependências
$ npm install 

Rodando a Aplicação

• Para utilizar esse projeto, o processo é bem simples. Após ter instalado, basta utilizar os seguintes comandos no terminal:

# Execute a aplicação em modo de desenvolvimento
$ npm run start

# O servidor inciará na porta: 3000 - acesse http://localhost:3000 

---

Contribuição

Contribuições são o que fazem a comunidade open source um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada.

1. Faça um Fork do projeto
2. Crie uma Branch para sua Feature (git checkout -b feature/FeatureIncrivel)
3. Adicione suas mudanças (git add .)
4. Comite suas mudanças (git commit -m 'Adicionando uma Feature incrível!)
5. Faça o Push da Branch (git push origin feature/FeatureIncrivel)
6. Abra um Pull Request

Contato

👤 Matheus Evangelista