https://github.com/tanzeem131/forkify
Forkify is a vanilla JavaScript application that interacts with the Forkify API v2 Documentation to fetch and display recipe food data. The user can search for a specific recipe, and save to a favorites list via local storage. The user can easily increase or decrease servings as per his need and can view detailed directions.
https://github.com/tanzeem131/forkify
Last synced: 2 months ago
JSON representation
Forkify is a vanilla JavaScript application that interacts with the Forkify API v2 Documentation to fetch and display recipe food data. The user can search for a specific recipe, and save to a favorites list via local storage. The user can easily increase or decrease servings as per his need and can view detailed directions.
- Host: GitHub
- URL: https://github.com/tanzeem131/forkify
- Owner: tanzeem131
- Created: 2024-02-01T16:56:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-01T20:04:06.000Z (about 1 year ago)
- Last Synced: 2025-02-01T17:41:50.413Z (4 months ago)
- Language: JavaScript
- Homepage: https://forkify-tanzeem131.netlify.app/
- Size: 3.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `Forkify`
A recipe search application made with javascript.
View Demo
## Forkify in Dark mode
## About The Project
Forkify is a vanilla JavaScript application that interacts with the **Forkify API v2 Documentation** to fetch and display recipe food data. The user can search for a specific recipe, and save to a favorites list via local storage. The user can easily increase or decrease servings as per his need and can view detailed directions.
### Built With
This app is built with pure vanilla JavaScript along with HTML and SCSS. It uses parcel as module bundler and NPM as package manager.
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
- [SCSS](https://sass-lang.com/)
- [CSS](https://css-tricks.com/)
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/javascript)
- [Parcel](https://parceljs.org/)
- [NPM](https://www.npmjs.com/)
- [MVC architecture](https://developer.mozilla.org/en-US/docs/Glossary/MVC)
- [babel](https://babeljs.io/docs/)
## Getting Started
To get started with project just simply fork this repo or download locally on your System.
To get a local copy up and running follow these simple example steps.
### Prerequisites
Start with the latest version of NPM to avoid any errors:
- npm
```sh
npm install npm@latest -g
```
- Also install additional dependencies
```
npm i --save core-js regenerator-runtime
```
### Installation
1. Get a free API Key at [Forkify API_KEY](https://forkify-api.herokuapp.com/v2)
2. Clone the repo
```sh
git clone https://github.com/catherineisonline/forkify
```
3. Install NPM packages
```sh
npm install
```
4. Enter your API in `config.js`
```JS
const KEY = 'ENTER YOUR API';
```
## Usage
1. The Forkify Recipe App allows users to search for recipes.
2. Users can view the recipe along with the cook time and also
increase or decrease the amount of servings they need.
3. Bookmarked recipes are stored in local storage so no database was
required for this application.
_For more examples, please refer to the [Documentation](https://forkify-api.herokuapp.com/v2)_
## Roadmap
See the [open issues](https://github.com/tanzeem131/Forkify/issues) for a list of proposed features (and known issues).
### Proposed features
## License
Distributed under the MIT License. See `LICENSE` for more information.