Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kenmarcos/users-crud

👥 CRUD básico de usuários com login (autenticação JWT)
https://github.com/kenmarcos/users-crud

bcrypt docker expressjs jsonwebtoken nodejs postgresql typeorm typescript yup

Last synced: about 1 month ago
JSON representation

👥 CRUD básico de usuários com login (autenticação JWT)

Host: GitHub
URL: https://github.com/kenmarcos/users-crud
Owner: kenmarcos
Created: 2023-07-28T21:22:05.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-07-28T22:20:44.000Z (over 1 year ago)
Last Synced: 2024-04-24T09:14:10.362Z (8 months ago)
Topics: bcrypt, docker, expressjs, jsonwebtoken, nodejs, postgresql, typeorm, typescript, yup
Language: TypeScript
Homepage: https://kenmarcos.github.io/users-crud/
Size: 324 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


    

       👥 Users Crud 👥

    

    

        Sobre o Projeto •

        Endpoints •

        Instalação •

        Utilização •

        Tecnologias •

        Autor

    



## 🖥️ Sobre o Projeto

> Projeto desenvolvido como parte das atividades do curso da Kenzie Academy Brasil.

Esse projeto consiste em uma aplicação back-end com um CRUD básico de usuários.

O objetivo do desenvolvimento desse projeto era praticar e aprimorar as habilidades em Node.js, Express.js e TypeORM.

Esse serviço possui uma API REST integrada a um banco de dados PostegreSQL.

Através dessa aplicação, um usuário pode se cadastrar, fazer login, atualizar seus dados, listar todos os usários cadastrados e remover um usuário.

## 💡 Endpoints

| Método | Endpoint       | Responsabilidade                                                                                        |

| ------ | -------------- | ------------------------------------------------------------------------------------------------------- |

| POST   | /users         | Cria um usuário                                                                                         |

| POST   | /login         | Gera um token JWT recebendo email e password no corpo da requisição como JSON.                          |

| GET    | /users         | Lista todos os usuários                                                                                 |

| GET    | /users/profile | Retorna os dados do usuário logado (usuário a qual pertence o token que será necessário neste endpoint) |

| PATCH  | /users/\ | Atualiza os dados de um usuário                                                                         |

| DELETE | /users/\ | Deleta usuários do banco                                                                                |

## ⚙️ Instalação

> Este projeto requer que o [Git](https://git-scm.com/), o [Node.js](https://nodejs.org/en/) e o [Docker](https://www.docker.com/) estejam instalados em sua máquina.

- Faça o fork desse repositório.

- Abra o terminal e clone o repositório:

```Bash

$ git clone [email protected]:/users-crud.git

```

- Entre no diretório do projeto:

```Bash

$ cd users-crud

```

- Instale as dependências:

```Bash

$ yarn install

```

- Adicione o arquivo `.env` na raiz do projeto e configure suas variáveis de ambiente seguindo o modelo do arquivo `.env.example`):

```dotenv

POSTGRES_USER=your_username

POSTGRES_PASSWORD=your_password

POSTGRES_DB=your_database

JWT_SECRET=your_secret_key

```

- Inicie o contêiner docker referente ao banco de dados PostgreSQL de acordo com as configurações do arquivo `docker-compose.yml`:

```Bash

$ docker-compose up

```

- Execute as _migrations_ para criar as tabelas no banco de dados:

```Bash

$ yarn typeorm migration:run

```

- Execute a aplicação:

```Bash

$ yarn dev

```

Pronto! A aplicação, agora, estará sendo executada através na rota https://localhost:3000/.

## 🚀 Utilização

> Para utilizar a aplicação, é necessário o uso de uma API Client, como [Postman](https://www.postman.com/) ou [Insomnia](https://insomnia.rest/download).

Verifique a [documentação](https://kenmarcos.github.io/users-crud/) da API.

## 🛠️ Tecnologias

Para o desenvolvimento desse projeto, as seguintes ferramentas foram utilizadas:

- **[Node.js](https://nodejs.org/)**

- **[Express.js](https://expressjs.com/)**

- **[TypeScript](https://www.typescriptlang.org/)**

- **[TypeORM](https://typeorm.io/)**

- **[Docker](https://www.docker.com/)**

- **[Bcrypt](https://www.npmjs.com/package/bcrypt)**

- **[JSON Web Token](https://www.npmjs.com/package/jsonwebtoken)**

- **[Yup](https://www.npmjs.com/package/yup)**

## 👨‍💻 Autor



Marcos Kenji Kuribayashi

[![Linkedin Badge](https://img.shields.io/badge/-LinkedIn-blue?style=flat&logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/marcos-kuribayashi/) [![Gmail Badge](https://img.shields.io/badge/[email protected]?style=flat&logo=Gmail&logoColor=white)](mailto:[email protected])

---

Desenvolvido por Marcos Kenji Kuribayashi 😉