https://github.com/priontoabdullah/beer-api-app
An open-source REST API of different kinds of beer to read the API and display it in an organized way with add in some sort of sorting, searching mechanic & recommendation algorithm to the front-end.
https://github.com/priontoabdullah/beer-api-app
infinity-scroll recommendation-algorithms rest-api searching-algorithms sorting-algorithms
Last synced: over 1 year ago
JSON representation
An open-source REST API of different kinds of beer to read the API and display it in an organized way with add in some sort of sorting, searching mechanic & recommendation algorithm to the front-end.
- Host: GitHub
- URL: https://github.com/priontoabdullah/beer-api-app
- Owner: PriontoAbdullah
- Created: 2021-09-13T06:12:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-14T17:28:03.000Z (over 4 years ago)
- Last Synced: 2025-01-13T11:24:54.997Z (over 1 year ago)
- Topics: infinity-scroll, recommendation-algorithms, rest-api, searching-algorithms, sorting-algorithms
- Language: JavaScript
- Homepage: https://beer-api-app.netlify.app/
- Size: 364 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Beer-API-APP
From a open-source REST API of different kinds of beer using HTML, CSS and Javascript to read the API and display it in an organized way. In addition, add in some sort of sorting, searching mechanic to the front-end.
## Live Links
- [https://beer-api-app.netlify.app/](https://beer-api-app.netlify.app/)
## API Links
- [Open Source API](https://www.programmableweb.com/api/punk-rest-api-v20)
- [API Documentation](https://punkapi.com/documentation/v2)
## API Reference
#### Get all items
```http
GET /api.punkapi.com/v2/${api_key}
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `beers` | `string` | **Required**. Gets beers from the api |
#### Get item
```http
GET /api.punkapi.com/v2/beers/${id}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `abv_gt` | `number` | Returns all beers with ABV greater than the supplied number |
| `abv_lt` | `number` | Returns all beers with ABV less than the supplied number |
| `ibu_gt` | `number` | Returns all beers with IBU greater than the supplied number |
| `ibu_lt` | `number` | Returns all beers with IBU less than the supplied number|
| `ebc_gt` | `number` | Returns all beers with EBC greater than the supplied number|
| `ebc_lt` | `number` | Returns all beers with EBC less than the supplied number|
## How To Run
> ### Install
```
npm install
```
> ### Build
```
npm run build
```
> ### Start
```
npm start
```