Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gustavo-martins-pereira/e-commerce_fullstack-backend
A learning project to apply all the knowledge from Front and Back
https://github.com/gustavo-martins-pereira/e-commerce_fullstack-backend
api clean-architecture dotenv express express-validator javascript jwt nodejs nodemon pg postgresql sequelize sequelize-cli
Last synced: about 2 months ago
JSON representation
A learning project to apply all the knowledge from Front and Back
- Host: GitHub
- URL: https://github.com/gustavo-martins-pereira/e-commerce_fullstack-backend
- Owner: gustavo-martins-pereira
- License: unlicense
- Created: 2024-06-19T23:59:10.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-10-24T15:48:33.000Z (3 months ago)
- Last Synced: 2024-10-25T16:10:28.682Z (3 months ago)
- Topics: api, clean-architecture, dotenv, express, express-validator, javascript, jwt, nodejs, nodemon, pg, postgresql, sequelize, sequelize-cli
- Language: JavaScript
- Homepage:
- Size: 178 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Backend do E-commerce FullStack
Backend para o funcionamento do site do Ecommerce *FullStack*, usando rotas *HTTP* e as entidades relacionadas as regras de negócio da aplicação, com rotas autorizadas através de **JWT**.
## Sumário
- [Tecnologias Utilizadas](#-tecnologias-usadas)
- [Instalação](#-instalação)
- [Estrutura do Projeto](#-estrutura-do-projeto)
## 🖥 Tecnologias Usadas
## ⚙ Instalação
Instruções para configurar o projeto localmente.
### Pré-requisitos
- [Node.js](https://nodejs.org/)
- [NPM](https://www.npmjs.com/) ou [NVM](https://github.com/nvm-sh/nvm)
> ⚠ A versão do Node.js que o projeto foi feito foi na versão **v20.15.1**, versões anteriores/posteriores podem não ser compatíveis com o projeto, caso tenha o **NVM** instalado, instale a versão correspondente com os comandos:
```bash
# installs nvm (Node Version Manager)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
# download and install Node.js (you may need to restart the terminal)
nvm install 20.15.1
# verifies the right Node.js version is in the environment
node -v # should print `v20.15.1`
# verifies the right npm version is in the environment
npm -v
```
#### OPCIONAL
- Baixe o aplicativo dektop do [Postman](https://www.postman.com/).
- Baixe o arquivo [JSON das Requisições](./readme/E-Commerce%20-%20FullStack.postman_collection.json)
1. Em seguida, no canto superior esquerdo no aplicativo do **Postman**, clique no botão "*Import*":
2. Selecione o arquivo **JSON** baixado no [link do JSON acima](#opcional) e importe o arquivo.
### Passos
1. Clone o repositório:
```sh
git clone https://github.com/gustavo-martins-pereira/E-commerce_FullStack-Backend.git
```
2. Navegue até o diretório do projeto:
```sh
cd nome-do-repositorio
```
3. Instale as dependências:
```sh
npm install
```
4. Configure o arquivo de ambiente `.env` conforme o seu banco PostgreSQL.
> Até o momento o banco usado no projeto é um banco de dados local
Passos para a configuração inicial do banco
1. Caso esteja usando o psql, para criar o banco de dados digite o comando:
CREATE DATABASE ecommerce;
⚠ Lembre-se que o nome do banco será usado para configurar a conexão com o banco de dados no arquivo .env
5. Para executar as *migrations* e *seeds* do projeto, em um terminal na raiz do projeto, digite o comando:
```bash
npm run setup-db
```
> ⚠ Existe a possibilidade de erro de dado duplicado quando o comando de *seed* estiver sendo executado, essa é uma ação NORMAL do banco de dados para evitar inconsistências na *DB*, caso aconteça, tente executar o comando `npm run seed` até que todas as seeds sejam executadas com sucesso
7. Em seguida, execute o projeto com:
```bash
npm run start
```
#### ⚠ JWT ⚠
Todas as rotas são protegidas por ***JWT*** (exceto a de registro, login e *refreshToken*), então antes de executar qualquer requisição, crie um novo usuário na rota de registro, e faça o login na rota de login para obter o ***Access Token***. O ***Access Token*** tem um prazo de validade de apenas **1 minuto**, e para obter um novo token de acesso, basta executar a rota de *refreshToken*.
> A duração é pequena para impedir danos relativos ao vazamento do token de acesso as rotas, para mais informações, acesse o conceito de [Access token e Refresh token](https://www.google.com/search?q=access%20token%20and%20refresh%20token%20jwt)
Lembrando que dependendo do tipo de usuário que você criar, as rotas podem ter acesso restrito, permitindo que somente usuário com certos tipos de *role* possam acessar aquele recurso.
## 📁 Estrutura do Projeto
```
/src
├── /config
├── /controllers
│ ├── entityController.js
├── /db
│ ├── /config
│ ├── /migrations
│ ├── /models
│ ├── /seeders
│ └── package.json
├── /middlewares
├── /repositories
│ ├── entityRepository.js
├── /routes
│ ├── /validators
│ └── routes.js
├── /services
│ ├── /entity
├── /utils
│ ├── /errors
│ └── encryption.js
└── server.js
.env
.env.example
.gitignore
.sequelizerc
LICENSE
package-lock.json
package.json
readme.md
```