Template Garcia

Descrição

Template Garcia é um modelo de projeto utilizando Sequelize, Express e outras dependências essenciais para a construção de APIs RESTful. Este projeto está configurado para usar PostgreSQL como banco de dados.

Instalação

Pré-requisitos

Node.js (>=14.x)
PostgreSQL

Passos para Instalação

Clone o repositório:

git clone https://github.com/glautonOsorio/TemplateGarcia-Sequelize

Navegue até o diretório do projeto:

cd template-garcia

Instale as dependências:

npm install

Configure as variáveis de ambiente criando um arquivo .env na raiz do projeto e preenchendo-o com suas configurações de banco de dados:

DB_HOST=localhost
DB_USER=seu_usuario
DB_PASSWORD=sua_senha
DB_NAME=seu_banco_de_dados
DB_DIALECT=postgres
JWT_SECRET=sua_chave_secreta

Scripts Disponíveis

Iniciar o Servidor

npm start

Iniciar o Servidor em Modo de Desenvolvimento

npm run dev

Executar Migrações

npm run db:migrate

Desfazer Migrações

npm run db:migrate:undo

Executar Seeders

npm run db:seed

Desfazer Seeders

npm run db:seed:undo

Gerar Documentação Swagger

npm run start:gendoc

Dependências

bcrypt: Para hashing de senhas.
cors: Para habilitar CORS.
dotenv: Para carregar variáveis de ambiente.
express: Framework web para Node.js.
jsonwebtoken: Para autenticação via JWT.
pg e pg-hstore: Para conexão com o PostgreSQL.
sequelize: ORM para Node.js.
swagger-autogen e swagger-ui-express: Para geração e exibição da documentação da API.
yup: Para validação de esquemas.

Documentação da API

A documentação da API é gerada automaticamente usando swagger-autogen e pode ser acessada em http://localhost:3000/api-docs após iniciar o servidor.

Licença

Este projeto está licenciado sob a licença ISC.

Autor

Autor: Glauton Osório
Gato do Autor: Uni
Amante de Batata: Batata

glautonOsorio / TemplateGarcia-Sequelize