Foodish - GitLite

KO | EN

gitlite — search

#typescript #golang #android #machine-learning #rust #linux #docker #macos #awesome #kubernetes #security #mcp #openai #open-source

Foodish

(★ 126)

A Node.js/Express.js REST API to GET a random picture of food dishes.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- - deploy.prod.yml
  - pull-request.yml
- pull_request_template.md
- swagger-api.json
- swagger.js
- biryani.json
- burger.json
- butter-chicken.json
- dessert.json
- dosa.json
- idly.json
- pasta.json
- pizza.json
- rice.json
- samosa.json
- logo.ico
- logo.png
- styles.css
- - imageMetaData.json
  - updateImageCount.js
- checkImageSize.js
- foodish.ejs
- notfound.ejs
.eslintrc.json
.gitignore
.prettierrc
app.js
CODEOWNERS
CONTRIBUTING.md
LICENSE
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/surhud004/Foodish

Downloads the entire project code from GitHub to your computer.

cd Foodish

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🍲 Foodish 🍛 [![Website](https://img.shields.io/website?down_color=critical&down_message=down&logo=foodish-api&up_color=success&up_message=up&url=https%3A%2F%2Ffoodish-api.com%2F)](https://foodish-api.com/) [![Deploy to Production](https://github.com/surhud004/Foodish/actions/workflows/deploy.prod.yml/badge.svg)](https://github.com/surhud004/Foodish/actions/workflows/deploy.prod.yml) [![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-green.svg?logo=github)](https://github.com/surhud004/Foodish/blob/main/CONTRIBUTING.md)

![Logo](https://github.com/surhud004/Foodish/blob/main/public/logo.ico 'Samosa')

A Node.js/Express.js REST API to GET a random picture of food dishes.

## Demo

Visit https://foodish-api.com/

## API Documentation

#### OpenAPI Specification Swagger v3: https://foodish-api.com/api-docs

Base URL for all endpoints https://foodish-api.com/

_The response time will likely be a few seconds long on the first request, because this app is running on a free instance. Subsequent requests will behave as normal._

You may support the project [here](#support).

### Endpoints

| Routes      | Description                            |
| ----------- | -------------------------------------- |
| `GET /api/` | Random food dish from random category. |

Example Request-

`GET /api/`

Example Response-

```
{"image":"https://foodish-api.com/images/burger/burger101.jpg"}
```

---

| Routes                  | Description                          |
| ----------------------- | ------------------------------------ |
| `GET /api/images/:food` | Random picture from `food` category. |

Please visit the [demo](https://github.com/surhud004/Foodish#demo) website to view the list of available `food` categories.

Example Request-

`GET /api/images/biryani`

Example Response-

```
{"image":"https://foodish-api.com/images/biryani/biryani32.jpg"}
```

---

## Usage

- You are designing a restaurant website and you want to add random food pictures as placeholders.
- You are creating a guess the food dish game.
- You are ordering a pizza but you just want a random choice, visit https://foodish-api.com/images/pizza/ because that's fun! Didn't like the pizza? Just hit refresh!
- You just like to see food pictures (visual hunger) because _you eat with your eyes first._

## Authors

- [Surhud](https://github.com/surhud004)

###### Please note that I do not own any of the Foodish dataset images. All Foodish images and their ownership belong to their original creators mentioned [below](#credits).

## Support

- Foodish is completely free to use, however, it requires some additional costs to keep the domain and service running. Help me keep it running by [donating here](https://www.paypal.com/donate/?business=WLR547JQ4WM92&no_recurring=0&item_name=To+keep+Foodish+running%21&currency_code=CAD)!
- For technical support and questions, please [create a new issue](https://github.com/surhud004/Foodish/issues/new).

## Contributing

Please read the [CONTRIBUTING](https://github.com/surhud004/Foodish/blob/main/CONTRIBUTING.md) for details on adding images to the Foodish Database.

## Credits

Foodish would not be possible without the work of:

- [Rajaraman Ekambaram](https://github.com/Rtech2014) for providing the initial Foodish image database via [Kaggle](https://www.kaggle.com/datasets).
- [RitaE](https://pixabay.com/users/ritae-19628/) for providing some additional Foodish images via [Pixabay](https://pixabay.com/).

## License

This project is licensed under [MIT](https://opensource.org/licenses/MIT). Please read the [LICENSE](https://github.com/surhud004/Foodish/blob/main/LICENSE) for details.

---

###### [Foodish API](https://github.com/surhud004/Foodish) is maintained by [surhud004](https://github.com/surhud004).