Thanks to visit codestin.com
Credit goes to github.com

Skip to content

API RESTful desenvolvida em Node.js e TypeScript para gestão de denúncias e feedbacks sobre saneamento em São Paulo. Integra-se ao PostgreSQL, utiliza autenticação JWT, documentação Swagger e segue boas práticas de CI/CD com GitHub Actions, oferecendo estrutura segura e escalável.

License

Notifications You must be signed in to change notification settings

RyanCNP/Backend-SaneaSP

Repository files navigation

Projeto SaneaSP

Integrantes

  • Davy Oliveira Ribeiro
  • Matheus Augusto Santos Gueff
  • Matheus Nery de Camargo
  • Pedro Silva Martins
  • Ryan Carlo Negretti Pereira

Hospedagem

O backend do SaneaSP foi hospedado na plataforma Render com conexão ao banco de dados Postgree fornecido.

Documentação Swagger

Endpoints do projeto:

FrontEnd do projeto

🔗 Repositório FrontEnd

Como rodar o projeto

Clone o repositório

git clone https://github.com/RyanCNP/Backend-SaneaSP.git

Instale as dependências

npm install

Defina as variáveis de ambiente

PORT = 3000

SECRET_KEY = sua_chave_secreta

DEV_DATABASE_URL = url_de_acesso_para_database

Para iniciar o projeto em desenvolvimento

npm run dev

Acesso para conteúdos protegidos

Email do usuário Senha Nível de acesso
[email protected] pedro 0
[email protected] math 1

Tecnologias utilizadas

Framework: Express

Linguagem: TypeScript

Banco de Dados: SQLite e PostgreeSQL com Sequelize como ORM

Comandos:

Inicialização do projeto

Para rodar o projeto localmente

npm run dev

Para iniciar a compilação do projeto para js

npm run build

Para iniciar o projeto compilado

npm run start

Migrations

Para criar uma nova migration

npm run migration-create <name>

Para iniciar as migrações

npm run migrate

Para desfazer as migrações

npm run migrate:undo

Para desfazer todas as migrações

npm run migrate:undo:all

PADRÃO DE COMMIT

Nova funcionalidade -->

feat: <breve-deacrição>

Correção de erro ou bug -->

fix: <breve-deacrição>

Documentação -->

docs: <breve-deacrição>

Refatoração de código -->

refactor: <breve-deacrição>

Nova funcionalidade que altera o modelo de negócio -->

feat!: <breve-descrição>

Alterações técnicas que não afetão o código fonte -->

chore(opicional):<breve-descrição>

PADRÃO DE BRANCH

Nova funcionalidade -->

feature/<nome-da-funcionalidade>

Correção de bug urgente -->

hotfix/<nome-da-correção>

Correção de bug -->

fix/<nome-do-bug>

About

API RESTful desenvolvida em Node.js e TypeScript para gestão de denúncias e feedbacks sobre saneamento em São Paulo. Integra-se ao PostgreSQL, utiliza autenticação JWT, documentação Swagger e segue boas práticas de CI/CD com GitHub Actions, oferecendo estrutura segura e escalável.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5