/foodexplorer_api

O food explorer é uma aplicação de gerenciamento de cardápio eletrônico, realizado como desafio final do programa Explorer da Rocketseat.

Primary LanguageJavaScript

🍚 Food Explorer 🍚

express javascript node sqlite

SobreDecolandoColaboradoresContribua

O Food Explorer é uma incrível aplicação web que simula um cardápio interativo de um restaurante fictício. Foi criado para proporcionar uma experiência envolvente e informativa aos usuários, tornando a exploração dos pratos, bebidas e opções do menu algo interativo e visualmente atraente. Com o Food Explorer, você pode navegar pelos pratos de maneira fácil, conferir imagens apetitosas, ler descrições detalhadas e obter informações completas sobre cada item, criando assim uma experiência gastronômica virtual única. Explore, descubra e mergulhe nesse mundo de sabores com o Food Explorer...

📌 Tecnologias

🚀 Decolando

Requisitos

Para rodar o projeto, você irá precisar:

Intalação

Clone o projeto usando o comando:

gh repo clone vhraposo/foodexplorer_api

Em seguida rode o comando:

cd foodexplorer_api
npm install ou yarn install

Rode as migrates:

npm run migrate ou yarn migrate

🗺️ Rotas

/user

create

{
  "name": "Jhon Doe",
  "email": "jhondoe@gmail.com",
  "password": "123456"
}

está rota precisa do token

update

{
  "name":"Jhon Doe",
  "email": "jhondoe@gmail.com",
  "password":"1234567",
}

show

retorno da API
{
  "name": "Jhon Doe",
  "email": "jhondoe@gmail.com",
  "avatar": "https://github.com/vhraposo.png",
}

/dishes

todas as rotas menos o index precisam do token

create

{
  "name": "Negroni",
  "description": "Um coquetel clássico e amargo, feito com gim, Campari e vermute doce.",
  "price": 35.00,
  "image": "https://www.guiadrinks.com.br/wp-content/uploads/2020/08/Negroni-768x512.jpg",
  "category": "Bebidas",
  "ingredients": ["Gim", "Campari", "Vermute doce"],
}

index | retorna todos os pratos

retorno da API
{
  "id": 1,
  "name": "Negroni",
  "description": "Um coquetel clássico e amargo, feito com gim, Campari e vermute doce.",
  "price": 35.00,
  "image": "https://www.guiadrinks.com.br/wp-content/uploads/2020/08/Negroni-768x512.jpg",
  "category": "Bebidas",
  "ingredients": ["Gim", "Campari", "Vermute doce"],
}

update | nessa e nas proximas rotas é necessario passar o id do prato como por exemplo json dishes/1

{
  "name": "Negroni 2.0",
  "description": "Um coquetel clássico e amargo, feito com gim, Campari e vermute doce.",
  "price": 55.00,
  "image": "https://www.guiadrinks.com.br/wp-content/uploads/2020/08/Negroni-768x512.jpg",
  "category": "Bebidas",
  "ingredients": ["Gim", "Campari", "Vermute doce, framboesa"],
}

show | nessa e nas proximas rotas é necessario passar o id do prato como por exemplo json dishes/1 Retorna o prato específico, baseado no ID

retorno da API
{
	"id": 1,
	"name": "Mousse de Maracujá",
	"description": "Cremosa mousse de maracujá com base de biscoito.",
	"price": 12.99,
	"category": "Sobremesas",
	"image": "https://static.itdg.com.br/images/1200-675/19903f5fde8b603c472469725008fd1f/shutterstock-1907121220.jpg",
	"created_at": "2024-02-16 18:44:59",
	"updated_at": "2024-02-16 18:44:59",
	"ingredients": [
		{
			"id": 4,
			"dish_id": 1,
			"name": "Biscoito maizena"
		},
		{
			"id": 3,
			"dish_id": 1,
			"name": "Creme de leite"
		},
		{
			"id": 2,
			"dish_id": 1,
			"name": "Leite condensado"
		},
		{
			"id": 1,
			"dish_id": 1,
			"name": "Suco de maracujá"
		}
	]
}

delete

/dishes/id
exemplo: /dishes/1

session

create

{
  "email": "jhondoe@gmail.com",
  "password": "123"
}

🤝 Colaboradores

Um agradecimento especial a todas as pessoas que contribuíram para este projeto.

Victor Raposo Profile Picture
Victor Raposo

📫 Contribua

Você pode contribuir com o projeto também!!

  1. gh repo clone vhraposo/foodexplorer_web
  2. git checkout -b feature/NAME
  3. Siga o padrão de commits.
  4. Abra um Pull Request explicando o problema resolvido ou recurso realizado, se existir, anexe screenshot das modificações visuais e aguarde a revisão!

Documentações que podem te ajudar nisso

📝 Como criar um pull request

💾 Padrão de commits

📄 Licença

O app **Food Explorer** é distribuída sob a licença MIT. Isso significa que você pode usar, modificar e distribuir o código desta API livremente, desde que inclua a declaração de direitos autorais e a licença MIT em qualquer cópia ou parte dela.