Skip to content

Latest commit

 

History

History
98 lines (81 loc) · 3.18 KB

File metadata and controls

98 lines (81 loc) · 3.18 KB

node-api-rawsql-example

README.md

Índice

🧾 Sobre o projeto

Este projeto foi feito para ser um simples exemplo de uma aplicação back-end usando SQL puro (sem ORMs ou Query builders)

🚀 Principais tecnologias

(Você pode ver todas as dependências do projeto no arquivo package.json)

💻 Como usar

Como você pode ver no tópico 🚀 Principais tecnologias, esta aplicação depende de um banco de dados PostgreSQL, então você deve tê-lo instalado.

  1. Faça o clone do projeto (você vai precisar de um personal access token):

    $ git clone https://github.com/victorbadaro/node-api-rawsql-example.git
  2. Acesse o diretório correspondente:

    $ cd node-api-rawsql-example
  3. Instale as dependências:

    $ yarn
    # sinta-se livre para usar outro gerenciador de pacotes, mas talvez você queira usar o yarn uma vez que já existe um arquivo yarn.lock na raíz do projeto
  4. Acesse o teu servidor PostgreSQL e crie o banco de dados (você pode nomear o banco de dados como quiser):

    CREATE DATABASE node_api_rawsql_db;
  5. Execute os comandos SQL que estão no arquivo database.sql

  6. Crie um arquivo .env na raíz do projeto com o mesmo conteúdo que está no arquivo .env.example e preencha as variáveis com os seus dados:
    Por exemplo:
    image

  7. Inicie o servidor executando o script dev:

    yarn dev

👌 Requisições

Agora o servidor está pronto para receber suas requisições! Tem uma request collection na raíz do projeto para que você possa usar (utilize o insomnia para importar a collection). Lembre-se de informar a porta do servidor na variável de ambiente baseUrl!
Aqui estão as requisições que você pode fazer:

  • GET /users

  • POST /users

    {
      "name": "",
      "email": ""
    }
  • GET /users/:id

  • PUT /users/:id

    {
      "name": "",
      "email": ""
    }
  • DELETE /users/:id

  • GET /products

  • POST /products

    {
      "description": "",
      "user_id": 
    }
  • GET /products/:id

  • PUT /products/:id

    {
      "description": "" 
    }
  • DELETE /products/:id


Este projeto foi criado e desenvolvido com ❤ por Victor Badaró