Projeto SuperFit

Descrição O projeto SuperFit é um servidor de API para gerenciamento de uma academia. Ele fornece endpoints para realizar operações CRUD (Create, Read, Update, Delete) em diferentes entidades, como pessoas, modalidades, planos, matrículas e horários de aulas.

E também gera um relatório que apresente o total de alunos por plano, o valor total recebido o total de alunos inadimplente e adimplentes. As rotas exigem um token de login, adquirido ao fazer login com email e cgc de um instrutor.

Tecnologias utilizadas

JSON Web Tokens (JWT)
TypeScript
Node.js
Express.js
PostgreSQL
dotenv

Funcionalidades

O servidor oferece as seguintes funcionalidades:

Autenticação de usuários através do endpoint /login.
Geração de relatorio através do endpoint /relatorio
Operações CRUD para a entidade "Pessoas" nos endpoints /pessoas.
Operações CRUD para a entidade "Modalidades" nos endpoints /modalidades.
Operações CRUD para a entidade "Planos" nos endpoints /planos.
Operações CRUD para a entidade "Matrículas" nos endpoints /matriculas.
Operações CRUD para a entidade "Horários de Aulas" nos endpoints /horarioaulas.
Operações CRUD para a entidade "Modalidades Planos" nos endpoints /modalidadesplanos.

Como utilizar

Clone o repositório do projeto:

git clone https://github.com/jorgehenrrique/api-CRUD-DB-SuperFit

Instale as dependências do projeto:
```
cd api-CRUD-DB-SuperFit
npm install
```

Crie um arquivo .env na raiz do projeto e defina as seguintes variáveis de ambiente:

 TOKEN_SECRET=secretToken
 HOST_PORT=3000

 DB_USER=postgres
 DB_HOST=localhost
 DB_NAME=DBName
 DB_PASS=yourPass
 DB_PORT=5432

Inicie o servidor:
```
   npm run dev
```
O servidor estará disponível em http://localhost:3000.

Resposta padrão

Caso uma requisição seja feita para um endpoint inexistente, o servidor retornará uma resposta com status 404 e uma mensagem informando que o link é inexistente.

Considerações finais

O projeto SuperFit é uma API completa para gerenciamento de diferentes entidades. Utilize os endpoints disponíveis para realizar operações CRUD nas respectivas entidades.

Consumo dos Endpoints disponíveis

A seguir estão listados os endpoints disponíveis no servidor e como utilizar:

/login: Endpoint para autenticação de usuários.
/relatorio: Endpoint para geração de relatórios.
/pessoas: Endpoint para operações CRUD na entidade "Pessoas".
/modalidades: Endpoint para operações CRUD na entidade "Modalidades".
/planos: Endpoint para operações CRUD na entidade "Planos".
/matriculas: Endpoint para operações CRUD na entidade "Matrículas".
/horarioaulas: Endpoint para operações CRUD na entidade "Horários de Aulas".
/modalidadesplanos: Endpoint para operações CRUD na entidade "Modalidades Planos".

Consumo das rotas

Login

URL: /login

Método: POST

Corpo da requisição:

{
  "cgc": "65748907123",
  "email": "carla@email"
}

Resposta:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNiIsIm5hbWUiOiJKb2FvIn0sImlhdCI6MTY0ODgzNjkzM30.FwioGSfHby1QII5zZ-Hxf-DUpCtT2I7DWchNiA9PFOs"
}

Salvar o token recebido para incluir nos headers das demais requisições.

Relatorio

URL: /relatorio

Método: GET

Headers: Authorization API Key

Resposta:

[
  {
    "plano": "Fit Dance",
    "total_alunos": "3",
    "valor_total_recebido": "209.70",
    "total_inadimplente": "1",
    "total_adimplente": "2"
  },
  {
    "plano": "Jiu-Jitsu",
    "total_alunos": "5",
    "valor_total_recebido": "654.80",
    "total_inadimplente": "1",
    "total_adimplente": "4"
  }
]

Pessoas listar

URL: /pessoas

Método: GET

Headers: Authorization API Key

Resposta:

json

Pessoas listar id

URL: /pessoas/:id

Método: GET

Headers: Authorization API Key

Resposta:

json

Pessoas criar

URL: /pessoas

Método: POST

Headers: Authorization API Key

Corpo da requisição:

{
  "nome": "Henrique II",
  "cgc": "000009000999",
  "tipo_pessoa": "F",
  "email": "novoE@email.com",
  "tipo_cadastro": "A",
  "ativo": "S"
}

Resposta:

json

Pessoas atualizar

URL: /pessoas/:id

Método: PUT

Headers: Authorization API Key

Corpo da requisição:

{
  "nome": "",
  "cgc": "",
  "tipo_pessoa": "",
  "email": "",
  "tipo_cadastro": "",
  "ativo": ""
}

Resposta:

json

Pessoas deletar

URL: /pessoas/:id

Método: DELETE

Headers: Authorization API Key

Resposta:

json

Modalidades listar

URL: /modalidades

Método: GET

Headers: Authorization API Key

Resposta:

json

Modalidades listar id

URL: /modalidades/:id

Método: GET

Headers: Authorization API Key

Resposta:

json

Modalidade criar

URL: /modalidades

Método: POST

Headers: Authorization API Key

Corpo da requisição:

{
  "nome": "NOME"
}

Resposta:

json

Modalidade atualizar

URL: /modalidades/:id

Método: PUT

Headers: Authorization API Key

Corpo da requisição:

{
  "nome": "NOME"
}

Resposta:

json

Modalidade deletar

URL: /modalidades/:id

Método: DELETE

Headers: Authorization API Key

Resposta:

json

Planos listar

URL: /planos

Método: GET

Headers: Authorization API Key

Resposta:

json

Planos listar id

URL: /planos/:id

Método: GET

Headers: Authorization API Key

Resposta:

json

Planos criar

URL: /planos

Método: POST

Headers: Authorization API Key

Corpo da requisição:

{
  "nome": "PLANO",
  "descricao": "Desc",
  "preco": "000.00"
}

Resposta:

json

Planos atualizar

URL: /planos/:id

Método: PUT

Headers: Authorization API Key

Corpo da requisição:

{
  "nome": "PLANO",
  "descricao": "Desc",
  "preco": "000.00"
}

Resposta:

json

Planos deletar

URL: /planos/:id

Método: DELETE

Headers: Authorization API Key

Resposta:

json

Modalidadesplanos listar

URL: /modalidadesplanos

Método: GET

Headers: Authorization API Key

Resposta:

json

Modalidadesplanos listar id

URL: /modalidadesplanos/:id/:id2

Método: GET

Headers: Authorization API Key

Resposta:

json

Modalidadesplanos criar

URL: /modalidadesplanos

Método: POST

Headers: Authorization API Key

Corpo da requisição:

{
  "plano_id": 00,
  "modalidade_id": 00
}

Resposta:

json

Modalidadesplanos atualizar

URL: /modalidadesplanos/:id/:id2

Método: PUT

Headers: Authorization API Key

Corpo da requisição:

{
  "plano_id": 00,
  "modalidade_id": 00
}

Resposta:

json

Modalidadesplanos deletar

URL: /modalidadesplanos/:id/:id2

Método: DELETE

Headers: Authorization API Key

Resposta:

json

Horarioaulas listar

URL: /horarioaulas

Método: GET

Headers: Authorization API Key

Resposta:

json

Horarioaulas listar id

URL: /horarioaulas/:id

Método: GET

Headers: Authorization API Key

Resposta:

json

Horarioaulas criar

URL: /horarioaulas

Método: POST

Headers: Authorization API Key

Corpo da requisição:

{
  "dia_semana": 0,
  "hora_inicio": "05:00:00",
  "hora_fim": "22:00:00",
  "modalidade_id": 2,
  "instrutor_id": 7
}

Resposta:

json

Horarioaulas atualizar

URL: /horarioaulas/:id

Método: PUT

Headers: Authorization API Key

Corpo da requisição:

{
  "dia_semana": 0,
  "hora_inicio": "05:00:00",
  "hora_fim": "22:00:00",
  "modalidade_id": 2,
  "instrutor_id": 7
}

Resposta:

json

Horarioaulas deletar

URL: /horarioaulas/:id

Método: DELETE

Headers: Authorization API Key

Resposta:

json

Matriculas listar

URL: /matriculas

Método: GET

Headers: Authorization API Key

Resposta:

json

Matriculas listar id

URL: /matriculas/:id

Método: GET

Headers: Authorization API Key

Resposta:

json

Matriculas criar

URL: /matriculas

Método: POST

Headers: Authorization API Key

Corpo da requisição:

{
  "aluno_id": 4,
  "plano_id": 2,
  "dia_vencimento": 0,
  "valor_mensalidade": "100.10",
  "data_inicio": "2023-07-06T03:00:00.000Z",
  "data_fim": "2024-06-06T03:00:00.000Z"
}

Resposta:

json

Matriculas atualizar

URL: /matriculas/:id

Método: PUT

Headers: Authorization API Key

Corpo da requisição:

{
  "aluno_id": 4,
  "plano_id": 2,
  "dia_vencimento": 0,
  "valor_mensalidade": "100.10",
  "data_inicio": "2023-07-06T03:00:00.000Z",
  "data_fim": "2024-06-06T03:00:00.000Z"
}

Resposta:

json

Matriculas deletar

URL: /matriculas/:id

Método: DELETE

Headers: Authorization API Key

Resposta:

json

Name		Name	Last commit message	Last commit date
Latest commit History 63 Commits
src		src
.env.example		.env.example
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
Projeto.md		Projeto.md
README.md		README.md
SuperFit.sql		SuperFit.sql
inicio.md		inicio.md
package.json		package.json
tsconfig.json		tsconfig.json

jorgehenrrique/api-CRUD-DB-SuperFit

Folders and files

Latest commit

History

Repository files navigation

Projeto SuperFit

Tecnologias utilizadas

Funcionalidades

Como utilizar

Resposta padrão

Considerações finais

Consumo dos Endpoints disponíveis

Consumo das rotas

Login

Relatorio

Pessoas listar

Pessoas listar id

Pessoas criar

Pessoas atualizar

Pessoas deletar

Modalidades listar

Modalidades listar id

Modalidade criar

Modalidade atualizar

Modalidade deletar

Planos listar

Planos listar id

Planos criar

Planos atualizar

Planos deletar

Modalidadesplanos listar

Modalidadesplanos listar id

Modalidadesplanos criar

Modalidadesplanos atualizar

Modalidadesplanos deletar

Horarioaulas listar

Horarioaulas listar id

Horarioaulas criar

Horarioaulas atualizar

Horarioaulas deletar

Matriculas listar

Matriculas listar id

Matriculas criar

Matriculas atualizar

Matriculas deletar

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Languages

Packages