SasCook (๑>؂•̀๑)

Let's cook ヾ( ˃ᴗ˂ )◞ • *✰

𐙚 Table of Contents

➺ About the Project

➺ Technologies & Environment

➺ Key Features

➺ Getting Started

➺ Usage

➺ Screenshots

➺ Contact

𐙚 About the project

This project was developed in 2023 as part of my Travail de Fin d'annee at ETML.
It is a recipe directory web application built with Laravel and styled entirely with Tailwind CSS. The project uses phpMyAdmin to manage a MySQL database.

The platform allows users to browse a wide variety of recipes, filter them by category or ingredients, and search for specific dishes. Logged-in users can add their own personal recipes and create a shopping list based on the ingredients they are missing.

𐙚 Technologies & Environment

✦︎ PHP 8.2.0

✦︎ Laravel Framework 10.10.1

✦︎ MySQL 5.7.11

✦︎ phpMyAdmin 5.2.0

✦︎ Composer 2.5.1

✦︎ uWamp 3.1.0 (for local server and database management)

✦︎ Node.js v18.13.0 (for Laravel Mix & asset management)

✦︎ Tailwind CSS 3.3.2

✦︎ Visual Studio Code

𐙚 Key Features

𖤝 Homepage

• Displays the latest recipe added
• Shows a random recipe that can be prepared in under 30 minutes

𖤝 Recipes Page

• Displays all available recipes
• Filters by category and ingredients
• A search bar to quickly find a recipe

𖤝 Recipe Details Page

• Full description with ingredients list.
• Option to adjust the number of servings, with dynamic recalculation of ingredient quantities

𖤝 User Authentication

• Logged-in users can add, edit, and manage their own recipes

𖤝 Shopping List

• Add missing ingredients from any recipe to a personal shopping list
• View all your shopping lists in a dedicated tab

𐙚 Getting Started

Requirements

✦︎ PHP >= 8.2

✦︎ Composer >= 2.5.1

✦︎ Node.js >= v18.13.0

✦︎ MySQL >= 5.7.11

✦︎ uWamp or equivalent local server environment

Setup

(ㅅ´ ˘ `)

Clone the GitHub repository using the following command

git clone [email protected]:SaskaPetrovic/SasCook.git

Install all the PHP dependencies of the project with Composer

composer install

Install JavaScript dependencies with npm

npm install

Create a .env file by copying .env.example

cp .env.example .env

Generate the Laravel application key with the following command

php artisan key:generate

Run the migrations

php artisan migrate

Seed the database with initial data

php artisan db:seed

Start the development server

php artisan serve

Access the project

http://127.0.0.1:8000

(づ ᴗ _ᴗ)づ♡

𐙚 Usage

𖹭 Browse all recipes in the "Recipes" tab

𖹭 Filter by categories and ingredients or use the search bar

𖹭 Open a recipe to see detailed instructions and adjust the number of servings

𖹭 Add recipes if you are logged in

𖹭 Create a shopping list by adding missing ingredients and consult it anytime from the dedicated tab

𐙚 Screenshots

Homepage

Recipes Page

Recipe Details Page

Add a recipe

View Demo on youtube ( ꈍ◡ꈍ)

☕︎ Connect with me

˗ˏˋ ✉︎ ˎˊ˗ [email protected]

˗ˏˋ ✎ ˎˊ˗ LinkedIn