in.orbit-api

KO | EN

gitlite — search

#hacktoberfest #react #ai #llm #go #machine-learning #deep-learning #nodejs #java #windows #cli #kubernetes #awesome-list #openai

(★ 3)

in.orbit-api é uma API Rest com o fim de realizar o gerenciamento de metas semanais, permitindo o cadastramento da meta, quantidade de dias que será realizada durante a semana, listagem, exibindo as metas da ultima semana baseando-se no dia atual com a contagem de dias que a meta foi realizada e permitindo a atualização de uma meta como concluída.

in.orbit-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
 <h1>in.orbit-api</h1>
 in.orbit-api é uma API Rest com o fim de realizar o gerenciamento de metas semanais, permitindo o cadastramento da meta, quantidade de dias que será realizada durante a semana, listagem, exibindo as metas da ultima semana baseando-se no dia atual com a contagem de dias que a meta foi realizada e permitindo a atualização de uma meta como concluída.
 <img src="/references/flow.png" alt="Flow" width="800">
</div>

# 📒 Índice
* [Descrição](#descrição)
* [Requisitos Funcionais](#requisitos)
  * [Features](#features)
* [Tecnologias](#tecnologias)
* [Endpoints](#endpoints)
* [Instalação](#instalação)
* [Licença](#licença)

# 📃 Descrição
in.orbit-api é uma API Rest com o fim de realizar o gerenciamento de metas semanais, permitindo o cadastramento da meta, quantidade de dias que será realizada durante a semana, listagem, exibindo as metas da ultima semana baseando-se no dia atual com a contagem de dias que a meta foi realizada e permitindo a atualização de uma meta como concluída. Aplicação desenvolvida utilizando a tecnologia [**TypeScript**](https://www.typescriptlang.org/), com a biblioteca [**Fastify**](https://www.fastify.io/) para web server, [**Drizzle ORM**](https://orm.drizzle.team/) para manipulação de dados do banco e o banco de dados SQL [**MySQL**](https://www.mysql.com/), [**Zod**](https://github.com/colinhacks/zod) para as validações e [**biomejs**](https://biomejs.dev/) para formatter e linter para a sintaxe.
.

# 📌 Requisitos Funcionais
- [x] Cadastrar metas para a semana com quantidade de dias para realizar 
- [x] Listagem das metas da ultima semana com quantidade de dias que foram completados na semana 
- [x] Marcar meta como completa, validando se não foi completada antes e contando os dias de concluído 
- [x] Resumo das metas da ultima semana com valor total das mesmas e detalhes de cada uma agrupadas por dia

## Features
- [x] Utilização de Common Table Expression (CTE)

# 💻 Tecnologias
- **TypeScript**
- **Fastify**
- **Zod**
- **drizzle-orm**
- **MySQL**
- **biomejs**

# 📍 Endpoints
| Método | Endpoint | Resumo 
|--------|----------------------|-----------------------------------------------------
<kbd>POST</kbd> | <kbd>/goals</kbd> | Responsável por cadastrar uma nova meta para a semana informado titulo e quantidade dias a serem realizada(s)
<kbd>GET</kbd> | <kbd>/pending-goals</kbd> | Responsável por listar as metas da ultima semana com a contagem dos dias de frequência completados e não completados
<kbd>POST</kbd> | <kbd>/completions</kbd> | Responsável por validar e marcar como concluída uma meta da semana, informando o ID via corpo de requisição, identificando se todos os dias foram completados
<kbd>GET</kbd> | <kbd>/summary</kbd> | Responsável por listar um resumo das metas da ultima semana com valor total das mesmas e detalhes de cada uma agrupadas por dia
<kbd>GET</kbd> | <kbd>/docs</kbd> | Responsável por servir a documentação dos recursos da API

# 🚀 Instalação
```bash
 # Clone este repositório:
 $ git clone https://github.com/CleilsonAndrade/in.orbit-api.git
 $ cd ./in.orbit-api

# Instalar as dependências:
  $ yarn install

# Aplicar migrações ao banco de dados:
  $ yarn drizzle-kit migrate

# Aplicar seed:
  $ yarn seed

# Executar:
  $ yarn dev
```

# 📝 Licença
Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.

---

Feito com 💜 by CleilsonAndrade

in.orbit-api

in.orbit-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

in.orbit-api

in.orbit-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README