leandroSalesCotrim/crud-mks

Crud realizado para o teste da vaga

📽 Cinema MKS 📽

Propósito

Projeto feito durante o processo seletivo da MKS Sistemas e tem como objetivo avaliar habilidades técnicas atravez da construção de uma API CRUD para um sistema de filme usando das ferramentas TypeScript, Nest.js, TypeORM, Swagger, Docker, Redis e PostgreSQL, e utilizando da autenticação JWT para obrigar o usuário estar autenticado ao consumir o CRUD.

Sobre

Um sistema de catalogo de filmes onde a API deve: Retornar todos os filmes disponiveis, armazenar o filme que o usuário enviou na request, permitir que seja feita a alteração de um filme e também a remoção do mesmo. Também foi implementado o sistema de cadastro e login de usuário para que cada usuário possa criar sua conta e realizar as request, por isso, somente o usuário logado consegue consumir o CRUD de filmes.

Tecnologias utilizadas e nivel de experiência

Projeto feito com base na arquitetura Model-Service-Controller.

Typescript - 0 de experiência anterior. NestJs - 0 de experiência anterior. TypeOrm - 0 de experiência anterior. Swagger - experiência academica de 1 ano. Docker - experiência profissional e acadêmica de 1 ano Redis - 0 de experiência anterior. PostgresSQL - 6 meses de experiência acadêmica. Render (Deploy) - 0 de experiência anterior.

Funcionamento usuario

POST /api/v1/usuario (Cadastro de usuário):

Espera que no body da requisição venha os dados do usuário e os insere na tabela usuario_model do banco de dados.

Exemplo

  {
    "userName": "leandrocotrim",
    "password": "senha123",
    "id": 1,
    "online": false
  }

POST /api/v1/usuario/login (Realiza o login do usuário):

Espera que no body da requisição venha os dados do usuário, verifica se condizem com um usuário do banco e retorna um token JWT de acesso, que também é armazenado no redis.

Exemplo

{
  "online": true,
  "auth_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImlhdCI6MTcwMTE3NTY4NH0.eHw5vARTyqJQwAXiMboR-Ni9KUDg36cn6U6QFXB42dM"
}

POST /api/v1/usuario/logout (Realiza o logout do usuário):

Espera que no header da requisição venha user_id e x-acess-token , verifica se condizem com um usuário do banco e realiza o logout definindo o status online para false e o valor armazenado no redis em branco.

Exemplo de entrada

  {
    "user_id": 1,
    "x-acess-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImlhdCI6MTcwMTE0MjQwM30.XyXoimPmbOJaSRF06dgQa_2PXmcvylbA6RwnJfyYFLQ"
  }

GET /api/v1/usuario (Retorna todos os usuarios e seus status):

Essa requisição espera conter o token gerado no login em seu header na chave x-acess-token, junto com o id do usuário também em um header na chave user_id

Exemplo de retorno

[
  {
    "userName": "leandrocotrim",
    "password": "senha123",
    "online": true
  },
  {
    "userName": "gabrielcotrim",
    "password": "senha321",
    "online": true
  }...
 ]

PUT /api/v1/usuario/:id/ (Altera o usuário):

Essa requisição espera conter o user_id e token gerado no login em seu header na chave e também um body contendo os novos dadosx-acess-token

Altera o usuário especificado na URL da requisição, para o novo body informado.

Exemplo de retorno da URL `/api/v1/usuario/1`

 {
   "userName": "loginNovo",
   "password": "senhaNova"
 }

DELETE /api/v1/usuario/:id (Remove o usuario):

Essa requisição espera conter o token gerado no login em seu header na chave x-acess-token
Remove o usuario especificado pela URL.

Exemplo de retorno da URL `/api/v1/usuario/1`

{
  "data": "O usuario com o id 2 foi deletado com sucesso!"
}

Funcionamento filme

POST /api/v1/filme (Cadastro de filme):

Espera que no body da requisição venha os dados do filme e os insere na tabela filme_model do banco de dados. Também espera conter o token gerado no login em seu header na chave x-acess-token, junto com o id do usuário também em um header na chave user_id

Exemplo de retorno

  {
    "nome": "Homem-Aranha 4",
    "genero": "Super-heroi",
    "lancamento": 2025,
    "duracao": "02:19",
    "id": 4
  }

GET /api/v1/filme (Retorna todos os filmes e seus status):

Essa requisição espera conter o token gerado no login em seu header na chave x-acess-token, junto com o id do usuário também em um header na chave user_id

Exemplo de retorno

"data": [
    {
      "id": 2,
      "nome": "Homem-Aranha 3",
      "genero": "Super-heroi",
      "lancamento": 2007,
      "duracao": "02:19"
    },
    {
      "id": 3,
      "nome": "Xmen",
      "genero": "Super-heroi",
      "lancamento": 2007,
      "duracao": "02:19"
    },
    {
      "id": 4,
      "nome": "Homem-Aranha 4",
      "genero": "Super-heroi",
      "lancamento": 2025,
      "duracao": "02:19"
    }
  ]

PUT /api/v1/filme/:id/ (Altera o filme):

Essa requisição espera conter o user_id e token gerado no login em seu header na chave e também um body contendo os novos dadosx-acess-token

Altera o filme especificado na URL da requisição, para o novo body informado.

Exemplo de retorno da URL `/api/v1/filme/1`

 {
   "id": 2,
   "nome": "Homem-Aranha 3",
   "genero": "Super-heroi",
   "lancamento": 2007,
   "duracao": "02:19"
 }

DELETE /api/v1/filme/:id (Remove o filme):

Essa requisição espera conter o token gerado no login em seu header na chave x-acess-token
Remove o filme especificado pela URL.

Exemplo de retorno da URL `/api/v1/filme/1`

{
  "data": "O filme com o id 4 foi deletado com sucesso!"
}

☁ Deploy ☁

Atualmente estou utilizando a plataforma Render para realizar o deploy da aplicação e os bancos, é possível acessar o deploy realizado neste link: https://cinme-mks.onrender.com/api/v1/swagger

Como rodar localmente 👨‍💻

⚠️ Necessário Docker e Docker-Compose ⚠️

1. Clone o repositório

$ git clone https://github.com/leandroSalesCotrim/crud-mks.git

2. Entre na pasta raíz do projeto

$ cd crud-mks

3. Instale as dependencias

$ npm install

4. Crie um arquivo .env contendo o conteudo abaixo

POSTGRES_DB=mksCinema
POSTGRES_USER=mksUser
POSTGRES_PASSWORD=mksPassword


POSTGRES_HOST=nest-postgres
REDIS_HOST=nest-redis

JWT_SECRET=segredoSecreto

5. Suba os containers já configurado com a aplicação e bancos

$ docker-compose up

⚠️ Extra ⚠️

Caso queira modificar a aplicação e ir realizando testes você pode executar apenas os comandos abaixo

1. Liste os container para visualizar o id dos container dos bancos redis e postgres

$ docker ps -a

2. Inicie o container do postgres

$ docker start id_do_container_postgres

4. Inicie o container do redis

$ docker start id_do_container_redis

5)Altere as varivaveis do arquivo .env para utilizar o localhost

REDIS_HOST=localhost
POSTGRES_HOST=localhost

6)Incie a aplicação localmente

$ npm run start:dev