Welcome to the documentation for our delightful Culinary Hub built with React and TypeScript. 🍲🍹
This project was made in one month by four students.
Our team of four first-year master's students in MIAGE proudly presents a comprehensive platform for culinary enthusiasts. This web application provides users with the ability to explore a vast collection of recipes, including culinary dishes, cocktails, and detailed nutrition information.
Browse through a diverse range of culinary recipes, carefully curated to cater to various tastes and preferences.
Discover and shake up your favorite cocktails with our extensive collection of cocktail recipes.
Stay informed about the nutritional content of different products from various brands, including Nutriscore ratings and the Nova classification.
- React: The foundation of our project, facilitating the creation of interactive and dynamic user interfaces.
- TypeScript: Enhancing code quality and providing a more robust development experience.
- Components: Leveraging React's component-based architecture for modular and reusable code.
- Hooks: Utilizing essential React hooks such as
useState,useEffect,useNavigate,useLocation, and custom hooks for efficient state management and navigation.
culinary-hub/
.
├── jest.config.js
├── package.json
├── README.md
├── src
│ ├── api
│ │ └── datadb.ts
│ ├── App.css
│ ├── App.tsx
│ ├── assets
│ │ ├── fried-egg.png
│ │ ├── goBackIcon.png
│ │ ├── img-not-found.png
│ │ ├── magnifying-glass.png
│ │ ├── sample-recipe.jpg
│ │ ├── search.png
│ │ └── yt-logo.png
│ ├── components
│ │ ├── Category
│ │ │ ├── Category.stories.tsx
│ │ │ ├── Category.tsx
│ │ │ └── style.css
│ │ ├── DetailRecipeCard
│ │ │ ├── DetailRecipeCard.stories.tsx
│ │ │ ├── DetailRecipeCard.tsx
│ │ │ └── style.css
│ │ ├── Navbar
│ │ │ ├── Navbar.stories.tsx
│ │ │ ├── Navbar.tsx
│ │ │ └── style.css
│ │ ├── Novascore
│ │ │ ├── Novascore.stories.tsx
│ │ │ ├── Novascore.tsx
│ │ │ └── style.css
│ │ ├── Nutriscore
│ │ ├── NutritionInfoCard
│ │ ├── PreviewRecipeCard
│ │ ├── RandomRecipeCard
│ │ ├── SearchBar
│ │ ├── SwitchDakMode
│ │ ├── SwitchSetting
│ │ └── YouTubeVideo
│ ├── constants
│ │ ├── RecipeType.ts
│ │ └── RouteBuilder.ts
│ ├── context
│ │ └── DarkModeContext.tsx
│ ├── dto
│ │ ├── FullRecipeDTO.ts
│ │ └── PreviewRecipeDTO.ts
│ ├── errors
│ │ └── NoResultFoundError.ts
│ ├── hooks
│ │ ├── cocktails
│ │ │ ├── useCocktailById.ts
│ │ │ ├── useCocktailsByName.ts
│ │ │ ├── useCocktailsByTextQuery.ts
│ │ │ └── useRandomCocktail.ts
│ │ ├── meals
│ │ │ ├── useMealById.ts
│ │ │ ├── useMealsByName.ts
│ │ │ ├── useMealsByTextQuery.ts
│ │ │ └── useRandomMeal.ts
│ │ └── nutrition
│ │ └── useNutritionInfo.ts
│ ├── index.css
│ ├── index.tsx
│ ├── mappers
│ │ ├── FullDrinkMapper.ts
│ │ ├── FullMealMapper.ts
│ │ ├── NutritionInformationMappper.ts
│ │ ├── PreviewDrinkMapper.ts
│ │ └── PreviewMealMapper.ts
│ └── pages
│ ├── Cocktail
│ │ ├── Cocktail.tsx
│ │ └── style.css
│ ├── Cocktails
│ │ ├── Cocktails.tsx
│ │ └── style.css
│ ├── Home
│ │ ├── Home.tsx
│ │ └── style.css
│ ├── Meal
│ ├── Meals
│ ├── Nutrition
│ ├── NutritionResults
│ └── SearchRecipes
├── tsconfig.json
└── yarn.lock
This project is licensed under the MIT License - see the LICENSE file for details.
Thank you for exploring our Culinary Hub!
In the project directory, you can run:
Run this command for installing project related dependencies. Do it going further.
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.