Git Product home page Git Product logo

crud-aws's Introduction

CRUD com Sequelize

🎯 Objetivo

Criar um CRUD Usando Typescritpt, princípios SOLID juntamente com banco de dados Postgres e ORM Sequelize

⛏️ Ferramentas Utilizadas

Pré-requisitos

Para a execução do projeto é necessário possuir o Node.JS (na sua versão 14.x ou superior), junto com Docker.

🐋 Usando Docker

Caso esteja utilize Docker para executar o projeto utilize os seguintes comandos:

docker-compose up # para subir o container e executar junto com a aplicação
docker-compose down # para parar o container após utilizar a aplicação

⚙ Arquivo de configuração

Aqui você irá criar o arquivo .env igual o .env.exampleinserindo os dados conforme é mostrado abaixo:

PORT=  # porta que a API vai usar
APP_SECRET= # Chave secreta que a aplicação irá usar

# abaixo ira definir os dados de entrada par a conexão com o banco de dados
POSTGRES_PASSWORD=
POSTGRES_USER=
POSTGRES_DB=
POSTGRES_HOST=
POSTGRES_PORT=

🚀 Instalação

Para instalar as dependências deve usar o seguinte comando:

yarn
# ou
npm install

🤖 Executar o projeto

Para executar o projeto utilize o comando:

yarn dev

Acesso ao projeto

Após executar o projeto o mesmo poderá ser visualizado através da URL:

http://localhost:{PORT}/api

Para executar sem que ocorrá o PORT do arquivo .env deve estar setado!

API

Para acessar a rotas deverá utilizar Insomnia ou Postman passando os valores como esta descrito abaixo

Metódo POST /login

Logar o usuário

Request
  • Body
{ "email": "[email protected]", "password": "asdfasdfasdfasdf" }
Response
{ "token": "token jwt" }

Metódo GET /logout

  • desloga o usuário

Metódo POST /users

Criar usuário

{
    "name": "robson",
    "email": "[email protected]",
    "password": "12345678"
}

Metódo GET /users

Buscar todos os usuário

  • sem body

Metódo PATCH /users

Alterar um usuário

{
    "id": 1, -> caso ide não seja passado ele irá retornar um erro
    "name": "robson",
    "email": "[email protected]",
    "password": "12345678"
}

Metódo GET /users/:id

Alterar um usuário um usuario

Metódo DELETE /users/:id

Deleta um usuário

crud-aws's People

Contributors

robsoncrlira avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.