SavourIt: API

SavourIt helps users create a shortlist of meal options from nearby restaurants based on their mood and budget making the problem of “what to eat” less time-consuming and stressful

Back End Repo

SavourIt Backend

Built With

• Major languages (Ruby)
• Framworks (Ruby on Rails)

Live Demo

SavourIt API

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Install

• Ruby
• Ruby on Rails
• PostgresSQL

Using it Locally

• Clone the project

git clone https://github.com/Co-Lab-You-Belong-in-Tech/savourIt_api
cd savourIt_api

Setup

Install gems with:

bundle install

Setup database with:

rails db:create
rails db:migrate
rails db:seed

Usage

Start server with:

rails server -p 3001

Visit http://localhost:3001/ in your browser.

API documentation

• Get list of hungers /api/v1/:lang//hungers

• Get list of allergens /api/v1/:lang/allergens

• Get list of categories /api/v1/:lang/categories

• Get list of avoid meals /api/v1/:lang/avoid_meals

• Get meal's detail /api/v1/:lang/meal/:id

• Get list of fancy meals /api/v1/:lang/country/:country/city/:city/fancy

• Get list of fancy meals filtered by hungry /api/v1/:lang/country/:country/city/:city/fancy?id_hungry=1

• Get list of meals /api/v1/:lang/country/:country/city/:city/meals

• Get list of meals filtered /api/v1/:lang/country/:country/city/:city/meals?minBudget=X&maxBudget=Y&id_hunger=Z&id_fancy=A&allergens=B&avoid_meals=C

• Filter meals :

  • minBudget: float
  • maxBudget: float
  • id_hunger: hunger id
  • id_fancy: category id
  • allergens: string, ids of allergen [Example: 1:2:3]
  • avoid_meals: string, ids of avoid meals [Example: 4:5:6]

All filters are optional. Language and City are not supported.

Authors

👤 J. AFLIH

• GitHub
• LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.