Foodieland API

💻 Projeto

foodieland é um site de receitas culinárias que oferece uma experiência intuitiva e prática para quem ama cozinhar. Aqui, você pode encontrar receitas de diversos tipos, desde pratos rápidos para o dia a dia até receitas sofisticadas para ocasiões especiais.

🌟 Funcionalidades

1. Receitas variadas: Desde pratos rápidos para o dia a dia até opções sofisticadas para ocasiões especiais.
2. Pesquisa intuitiva: Encontre receitas por nome, ingredientes ou categoria.
3. Favoritos: Salve suas receitas preferidas para acessar facilmente depois.
4. Passo a passo detalhado: Instruções claras para garantir que qualquer pessoa possa preparar as receitas com sucesso.

🧪 Technologies

Esse projeto foi desenvolvido com as seguintes tecnologias:

• Typescript
• Drizzle-orm
• Supertest
• Vitest
• Fastify
• Fastify-cors
• Fastify-formbody
• Fastify-static
• Fastify-swagger
• Fastify-swagger-ui
• Chalk
• Postgres
• Zod

🚀 Instalação

  # Clone o repositório e entre na pasta do projeto
  $ git clone https://github.com/RayanneRamos/foodieland-api.git
  $ cd foodieland-api
  # Configure o banco de dados
  $ docker compose up -d
  # Configure as variávreis de ambiente
  $ Copie o arquivo .env.example e adicione suas variáveis
  # Instale as dependências
  $ npm install
  # ou
  $ yarn install
  # Execute a aplicação
  $ npm run dev
  # ou
  $ yarn start

🧩 Rotas do Server

Aqui você encontra todas as rotas disponíveis na aplicação.

• POST http://localhost:3333/create-category - Create a category
• GET http://localhost:3333/categories- Get categories
• GET http://localhost:3333/categories/:categoryId - Get a category by category id
• POST http://localhost:3333/create-author - Create an author
• POST http://localhost:3333/create-nutrition- Create nutrition info for a recipe
• POST http://localhost:3333/create-direction - Create a recipe direction info for a recipe
• POST http://localhost:3333/create-ingredients - Create a recipe ingredients info for a recipe
• POST http://localhost:3333/create-recipe- Create a full recipe with author, ingredients, directions and nutrition
• GET http://localhost:3333/recipes - Get recipes
• GET http://localhost:3333/recipes/:id - Get a recipe by id
• GET http://localhost:3333/recipes/category/:categoryId- Get recipe by category
• POST http://localhost:3333/posts/:postId/sections - Create a section for a post
• POST http://localhost:3333/create-post - Create a post
• GET http://localhost:3333/posts- Get all blog posts
• GET http://localhost:3333/posts/:id - Get a post by id
• POST http://localhost:3333/create-message - Create a contact message
• GET http://localhost:3333/messages- Get all messages
• GET http://localhost:3333/messages/:enquiryType - Get a message by enquiry type
• POST http://localhost:3333/register-newsletter - Subscribe an email to the newsletter
• GET http://localhost:3333/newsletter- Get all newsletter emails
• DELETE http://localhost:3333/delete-newsletter/:id - Delete a newsletter email by id

Para acessar a documentação da aplicação, execute o server e abra no navegador http://localhost:3333/docs

🔖 Layout

• Web

📝 License

Este projeto está licenciado sob a Licença MIT. Veja o arquivo LICENSE para obter mais detalhes.

---

Criado by Rayanne Ramos