/recipe_search

Recipe Search 🍴 is not an ordinary recipe search application.

Primary LanguageTypeScript

Introduction

β€œRecipe Search 🍴 is not an ordinary recipe search application.

πŸ’‘ Key Features

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

πŸ”₯  Live Demo

App 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