Ao Mosso UFC

🔖 Sumário

• Sobre o Projeto
• Rotas do Projeto
• Tecnologias
  • Construção da API
  • Testes
  • IDE, Versionamento e Deploy
• Configurações e Instalação
  • Requisitos
• Licença

🍽️ Sobre o Projeto

Essa é uma API que fornece as refeições ofertadas pelos Restaurantes Universitários da Universidade Federal do Ceará.

📁 Rotas do Projeto

• GET /{:restaurant} Obtém o cardápio do dia do restaurante pesquisado.
• GET /{:restaurant}/{:date} Obtém o cardápio da data especificada do restaurante pesquisado.

🔧 Tecnologias

Tecnologias utilizadas no projeto.

Construção da API

• TypeScript
• Fastify
• Node.js
• Axios
• Cheerio
• Zod

Testes

• Vitest

IDE, Versionamento e Deploy

• Visual Studio Code
• Git
• GitHub
• Render

🚀 Configurações e Instalação

Requisitos

• Node e pnpm.
• Teste das chamadas realizados com HTTPie.

# Caso não tenha o pnpm, execute:
npm install -g pnpm

Recomendo que veja a documentação de configuração do Fastify.

# Clonando o projeto
git clone https://github.com/davsilvam/ao-mosso-ufc-api.git

# Instalando as dependências
pnpm install

# Rodar o servidor em desenvolvimento
pnpm start:dev

# Iniciar testes
pnpm test

# Compilar e minificar para produção
pnpm build

# Rodar o servidor em produção
pnpm start

⚖️ Licença

Esse projeto está sob a licença MIT.

---

Feito com 🤍 e ☕ por David Silva.

Portfólio  ·  GitHub @davsilvam  ·  Instagram @davsilvam_