Introduction

“Recipe Search 🍴 is not an ordinary recipe search application.

💡 Key Features

• Typescript
• Redux
• React-Routing
• React-Routing
• Docker
• Husky
• Debounce & Throttling

🔥  Live Demo

🚀  Installation

To clone and run this application, you'll need Git, Docker installed on your computer.

# Clone this repository
$ git clone https://github.com/gadgetvala/recipe_search.git

# Go into the repository
$ cd recipe_search/

# Start Application
$ docker-compose up

📦  Packages

Some very good packages are used in the project, not a big list. Below are the information about these packages.

package	explain
axios	Promise based HTTP client for the browser and node.js
lodash.debounce	Debounce Function
styled-components	Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress

🧵  Directory Structure

The project directory structure in src is as follows:

├── api
├── assets
├── components
├── constants
├── interfaces
├── pages
├── redux_config
├── styles
├── types
├── App.tsx
├── index.tsx

Let me explain the other directories.

directory	explain
api	Contain API configuration & Functions
assets	Contain static assets for app
components	Contain all global shared Components
constants	Global & App Constants
interfaces	Interface for APIS & UI Compoents
pages	Pages Components for Routing
redux_config	All Configs and Store
styles	Global Styles
types	Types for Typescript compiler6
App.tsx	Main App Routing Point
index.tsx	Main App Entry Point

👏 Done

Feel free to file a new issue with a respective title and description on the the recipe_search repository. If you already found a solution to your problem, I would love to review your pull request!

📘  License

The recipe_search app is released under the under terms of the MIT License.

❤️ Contributor

Made by Suraj Verma