Chef's Helper

Discover the ultimate solution for your culinary adventures! Our application empowers you to create, store, and explore a world of recipes, all in one place. Whether you're a seasoned chef or a home cook, our platform is designed to enhance your cooking experience. Join our thriving culinary community today and elevate your cooking journey with our feature-rich, user-friendly application. It's not just a recipe app; it's your culinary companion. Start creating, exploring, and savouring the joy of cooking!

Chef's Helper live website here

Testing

User Experience (UX)

Dive into an immersive culinary journey with Chef's Helper's Recipe Management feature. Our platform offers a seamless and engaging user experience, ensuring effortless organization and exploration of your favourite recipes. Experience the convenience of storing, viewing, and managing your own culinary creations, alongside the ability to discover, review, rate, and like recipes contributed by fellow users.

The Recipe Management system is designed with user-friendly navigation, providing a visually stunning interface for an enjoyable and hassle-free experience. Whether you're a seasoned chef or a home cook, our personalized recommendations and comprehensive information cater to your unique preferences, making each step of your culinary adventure delightful.

Create a personalized collection of recipes, easily accessible from any device with our mobile-friendly design. Edit your recipes with ease, add new ingredients, and share your culinary masterpieces with the Chef's Helper community. Explore a treasure trove of diverse recipes contributed by others, offering inspiration for your next kitchen endeavour.

Feel the satisfaction of not only managing your culinary creations but also engaging with a community passionate about food. Leave reviews, rate recipes, and show appreciation by liking outstanding dishes. For those cherished favourites, the option to print your recipes ensures they are always at your fingertips, ready to impress friends and family.

Chef's Helper's Recipe Management is more than just a tool; it's a culinary haven where your cooking journey transforms into a delightful and enriching experience. Join us in celebrating the art of cooking, sharing, and savouring the flavour of a vibrant and thriving culinary community.

Project Goals

Chef's Helper aims to create a user-friendly online platform for culinary enthusiasts. The project focuses on:

Seamless Experience: Provide an intuitive interface for effortless recipe storage, management, and exploration.
Community Engagement: Foster a vibrant community where users can view, review, rate, and like recipes shared by fellow enthusiasts.
Effortless Management: Simplify the process of editing recipes, adding ingredients, and navigating through collections.
Print and Share: Enhance the joy of sharing culinary creations by allowing users to print their favourite recipes.
Mobile Accessibility: Prioritize accessibility with a mobile-friendly design for planning and managing recipes on any device.

Agile Methodology

Agile Methodology served as the guiding framework for prioritizing and organizing tasks in the Chef's Helper app development process. The workflow included:

User Story Creation: Utilizing the Agile approach, user stories were meticulously crafted, and a template was established to streamline the process. This allowed for a clear definition of project goals and user requirements.
Epics Development: Epics, each containing potential user stories, were formulated. These epics served as overarching themes, providing a foundation for the subsequent development of the Chef's Helper website.
Iterative Progression: User stories were generated by analyzing and refining the epics. Through iterative cycles, the project steadily advanced, ensuring that each user story contributed to the overall development goals.
Public Project Board on Github: A Project Board, accessible to the public, was implemented on Github. This board acted as a centralized hub for task tracking, employing columns such as Todo, In Progress, and Done.
Progress Tracking: The Project Board played a pivotal role in tracking the progression of tasks. Issues smoothly transitioned through the different columns, providing a visual representation of the project's status.
Labeling for Priority: Labels were strategically added to categorize issues based on their importance. This labeling system facilitated a systematic organization of tasks, allowing the team to focus on critical aspects and prioritize accordingly.

In essence, the Agile Methodology, coupled with Github's Project Boards and a structured template for user stories and epics, ensured an efficient and collaborative approach to Chef's Helper app development. This methodology allowed for flexibility, adaptability, and continuous improvement throughout the project lifecycle.

User Stories Template

User Stories, Issues

Project Milestones

Project Board

Visit project GitHub page here.

User Stories

Epics

Project Setup and Initialization
Website Admin Management
Recipe Management System
Frontend Refinement and Content Enrichment
Comprehensive Documentation Enhancement

User Stories

Project set up
- Develop wireframes for the user interface of the application.
- Design Entity-Relationship Diagrams (ERD).
- Create a new Heroku application.
- Link the Github repository to the Heroku app.
Site Navigation
- Create a base.html file.
- Create the Navigation tabs for the site header.
- Create links for navigation tabs on each page.
Social network bar
- Create the footer
- Create a link for social sites on each page.
User Registration
- Sign Up page.
- User registration, log in, log out.
- Display the users' name.
Manage recipes
- Admin panel.
- Crud functionality
- Admin dashboard functionality.
Create drafts
- Add ingredients in the admin panel to the recipe.
- Recipe can be saved as a draft.
Approve reviews
- Allow admin to approve reviews
- Allow admin to create reviews through the admin panel
Review a recipe
- Create a form to allow user review the recipe
- Allow user to rate recipe only once
Like a recipe
- Allow user to like recipe only once
View reviews
- Allow users to view approved reviews.
- Create a mechanism to calculate the average rating.
Add a recipe
- Create a recipe form
- Create a recipe template
Open a recipe
- Create a recipe card template
Add an ingredient to the recipe
- Create an ingredient form.
View likes
- Display the like count next to the recipe.
Online recipe book
- Add recipe content to the page.
Enhance Frontend Styling and Responsiveness
- Create a home page.
- Maintain consistent design.
- Test responsiveness.
Readme file
- Create comprehensive application's documentation.

Detailed look can be found on the project board

Target Audience

Home Cooks and Chefs: Individuals passionate about cooking, seeking a platform to store, manage, and share their recipes.
Recipe Enthusiasts: Those who enjoy discovering and trying out new recipes, leaving reviews, and engaging with a culinary community.
Tech-Savvy Foodies: Users who appreciate a seamless and user-friendly digital experience for managing their culinary creations.
Mobile Users: Individuals who prefer the convenience of accessing recipe management tools from their mobile devices.
Community-Driven Individuals: Those interested in engaging with a community of like-minded individuals, sharing culinary tips and inspiration.
Culinary Creatives: Home cooks, aspiring chefs, and culinary artists looking for a platform to showcase their creativity.
Families: Families who want to collect and manage their favourite recipes for shared meals and special occasions.
Healthy Lifestyle Enthusiasts: Individuals interested in maintaining a healthy lifestyle through diverse and nutritious recipes. Chef's Helper caters to a diverse audience of culinary enthusiasts, providing a hub for creativity, community, and culinary exploration.

First time user

Simple and intuitive website navigation for easy exploration and discovery.
Engaging visuals showcasing the various dishes of public recipes.
Informative content providing an overview of application functionality and future updates.
Search bar, to allow user to find their favourite dishes.
Easy Registration process.

Registered User

Seamless login process with a secure and personalized user account.
Browsing recipe details.
Printing.
Adding new recipes.
Updating own recipes.
Reviewing, rating and liking recipes.

Admin user

Secure and separate login portal for admin users with appropriate access control.
Access to an admin dashboard for recipes, reviews and ingredients.
Ability to add, edit, or delete recipes, including ingredients, reviews and likes.
Management of recipe options, such as adding, updating, or removing ingredients and reviews.
Ability to delete user accounts, providing the necessary control for managing user data and accounts.
Management of recipes, including the ability to view, modify, or delete recipes as needed.

Design

The design of Chef's Helper platform is carefully crafted to provide a visually appealing and user-friendly experience. The design strikes a balance between simplicity and sophistication, ensuring a clean and modern appearance. The light blue background creates a harmonious backdrop for the culinary-focused content. The design emphasizes user interaction, with hover styles applied to key elements such as navigation, social links, and recipe cards. This provides users with a responsive and dynamic experience as they navigate through the platform. The consistent use of the color scheme, fonts, and styling elements across the platform creates a cohesive and unified visual identity. The design of Chef's Helper is tailored to appeal to users seeking a seamless and visually delightful experience while exploring and managing their recipes.

Color Scheme

The predominant color is a soothing light blue background #cff4fc , creating a calm and inviting atmosphere for users.
The CH logo is elegantly presented in gold letters #dfb705, adding a touch of sophistication to the overall design.
The font choice is a classic black #000, ensuring readability and a timeless aesthetic.
Navigation elements, including the nav bar and social links, are designed to respond dynamically to user interaction. On hover, the color transitions to a rich burgundy #630a0a, providing visual feedback. Recipe Cards:
Recipe cards are styled with a hover effect to enhance the user's interaction. On hover, the card scales slightly increasing the size for a subtle animation. Additionally, a drop shadow is applied #2759fc to create depth and highlight the selected card.

Recipe Images

Various high-quality images of delectable foods are strategically placed to evoke the essence of culinary delight. These images contribute to an immersive and engaging visual experience. All recipe images were created using Canva software.

Logo

Logo was also created using Canva software.

Typography

Lato is a modern and versatile sans-serif font. With a clean and friendly appearance, it ensures readability across various platforms. Ideal for paragraphs and body text, Lato provides a contemporary and professional look.
Roboto Slab is a serif font with a stylish and sophisticated feel. It adds a touch of elegance to headings and subheadings, making it suitable for conveying a sense of formality and structure in your design.
Pacifico is a lively and casual cursive font that brings a playful and handwritten charm to your special text. Perfect for creating a personalized and whimsical touch, Pacifico adds character and warmth to headings or elements you want to highlight.

Wireframes

Home Page

User Sign Up Page

User Login Page

Add Recipe Page / Update Recipe Page

Recipe Detail View Page

Recipe Images Page

Database Scheme

Entity Relationship Diagram (ERD)

The current data scheme comprises models essential for the Minimum Viable Product (MVP) of the recipe management system. However, future updates are planned to enhance the application's functionality. The upcoming features include the addition of Categories to recipes, enabling users to better organize and filter recipes by category and allergens. This enhancement ensures that the system accommodates dietary needs and provides nutritional information for each ingredient and meal created using the recipes.

In subsequent phases, the system will introduce a Supplier model to transform the application into a comprehensive tool for the hospitality sector. This addition will facilitate inventory management, catering to the specific needs of commercial users. The planned updates align with a strategic roadmap, progressively expanding the capabilities of the recipe management system to meet evolving user requirements and industry demands.

Data Scheme

Data Models

Allauth User Model
- Django Allauth is a third-party Django package that provides a set of authentication, registration, and account management functionality for Django web applications. It's designed to handle various aspects of user authentication, including login, registration, and more.
- Django Allauth provides the default User model for authentication within the recipe management system.
- The User etnity has one-to-many relationship with the Recipe entity, allowing each User to create a multiple recipes. Also, each individual recipe is associated with only one User, this means that users can create and manage their own collection of recipes, and each recipe is attributed to a specific user..
Recipe Model
- The Recipe model in the system represents a culinary recipe and encapsulates various attributes, including the recipe's title, author, creation/update timestamps, instructions, ingredients, featured image, and additional details related to preparation and user interactions.
- Fields:
- title: CharField for the title of the recipe, ensuring uniqueness.
- slug: SlugField for a URL-friendly version of the title.
- author: ForeignKey to the User model, establishing a many-to-one relationship.
- created_on: DateTimeField for the creation timestamp.
- updated_on: DateTimeField for the last update timestamp.
- instructions: TextField for the detailed recipe instructions.
- ingredients: ManyToManyField to the RecipeIngredient model, forming a many-to-many relationship.
- featured_image: CloudinaryField for storing images, with a default placeholder image.
- excerpt: TextField for a brief description or summary (optional).
- likes: ManyToManyField to the User model, allowing users to express their liking for a recipe.
- prep_time: IntegerField for the preparation time in minutes (optional).
- cook_time: IntegerField for the cooking time in minutes (optional).
- servings: IntegerField for the default number of servings.
- rating: FloatField for the overall rating, constrained between 1 and 5.
- total_ratings: IntegerField for the total number of ratings.
- status: IntegerField with choices representing the status of the recipe (Draft or Published).
- rated_users: ManyToManyField to the User model, tracking users who have rated the recipe.
- sum_of_rating: FloatField for the cumulative sum of all ratings.
- Meta specifies the default ordering based on the recipe title in descending order.
- Methods:
- __str__(self): Returns the title of the recipe when converted to a string.
- number_of_likes(self): Returns the count of likes for the recipe.
- number_of_reviews(self): Returns the count of reviews for the recipe.
- rate_recipe(self, user, user_rating): Records a user's rating for the recipe, updating the total rating and user rating history.
- calculate_average_rating(self): Calculates and returns the average rating for the recipe.
- has_unapproved_reviews(self): Checks if there are unapproved reviews for the recipe.
- Custom save method to create a unique slug for each recipe, ensuring a URL-friendly representation.
- This model empowers the system to manage and present a diverse array of recipes, supporting interactions such as liking, rating, and reviewing. The inclusion of features like unique slugs and status tracking enhances the robustness of the recipe management system.
RecipeIngredient Model
- The RecipeIngredient model represents an individual ingredient used in a recipe. It encapsulates information such as the ingredient's name, quantity, unit of measurement, and the recipe to which it belongs.
- Fields:
- name: CharField for the name of the ingredient.
- quantity: DecimalField for the quantity of the ingredient.
- unit: CharField for the unit of measurement.
- recipe: ForeignKey to the Recipe model, establishing a many-to-one relationship.
- This model serves as a crucial component in the recipe system, allowing for the detailed specification of each ingredient within a recipe. The ForeignKey establishes a link to the associated recipe, facilitating the organization and retrieval of ingredient information when needed. The __str__ method provides a readable string representation for ease of use and display.
Review Model
- The Review model represents user reviews for a specific recipe within the recipe management system. It includes essential details such as the reviewer's name, email, the content of the review, creation timestamp, and approval status.
- Fields:
- recipe: ForeignKey to the Recipe model, establishing a many-to-one relationship.
- name: CharField for the name of the reviewer.
- email: EmailField for the email of the reviewer.
- body: TextField for the content of the review.
- created_on: DateTimeField for the creation timestamp.
- approved: BooleanField indicating whether the review has been approved (default is False).
- Meta specifies the default ordering based on the creation timestamp in ascending order.
- This model plays a crucial role in collecting and managing user feedback for recipes. The ForeignKey establishes a link to the associated recipe, allowing for easy retrieval and organization of reviews. The approval status (approved) provides a mechanism to control the visibility of reviews, with the default set to False. The __str__ method ensures a meaningful and readable representation of reviews when converted to a string. The ordering meta attribute ensures that reviews are sorted based on their creation timestamp.

User Journey

Security Features

User Authentication

Django Allauth is a powerful and comprehensive third-party package for handling authentication, registration, and account management in Django applications. It provides several security features to help protect user accounts and sensitive information.

LoginRequiredMixin

In Django, LoginRequiredMixin is a mixin class provided by the django.contrib.auth.mixins module. It is used in class-based views to require that the user making the request must be authenticated. If the user is not authenticated, the mixin will automatically redirect the user to the login page.
You can use LoginRequiredMixin by inheriting it in your class-based views. Typically, it's used as the leftmost mixin in the inheritance chain to ensure that authentication checks are performed before any other mixins. If the user is authenticated, the view proceeds as normal. If the user is not authenticated, the LoginRequiredMixin automatically redirects them to the login page.
Using LoginRequiredMixin helps in enforcing authentication requirements for views where you want to ensure that only authenticated users have access. It simplifies the process of handling authentication checks and redirects in class-based views.

CSRF Protection

In Django, CSRF (Cross-Site Request Forgery) protection is implemented using a CSRF token. The CSRF token is a unique value associated with a user's session, and it is used to verify the legitimacy of a form submission. When a user logs in or visits a page with a form, Django generates a unique CSRF token for that user's session. Django provides built-in middleware (django.middleware.csrf.CsrfViewMiddleware) that automatically checks and enforces CSRF protection for all incoming POST requests. The middleware ensures that each form submission includes a valid CSRF token. By incorporating these CSRF protection mechanisms, Django helps prevent attackers from executing malicious actions on behalf of authenticated users. The use of unique tokens tied to user sessions adds an additional layer of security, ensuring that form submissions are authorized and originate from legitimate sources.
When rendering an HTML form, Django includes the CSRF token as a hidden input field within the form. The {% csrf_token %} template tag is used to include the CSRF token in the form. See example below:

<form method="post" action="{% url 'custom_view' %}">
    {% csrf_token %}
    {% form.as_p %}

    <button type="submit">Submit</button>
</form>

Custom Views Security Measures

Overall, views incorporate authentication checks, form validation, and ownership verification to secure various operations. It's important to note that Django's built-in features, such as the authentication system, contribute to the overall security of the application. RecipeList:
- The RecipeDetails view requires authentication (LoginRequiredMixin) to access recipe details. It includes forms for adding reviews and ratings. Security measures include validating user input using Django forms (ReviewForm and RecipeForm), ensuring that only authenticated users can submit reviews and ratings.
- The RecipeLike view handles user likes for a recipe. It toggles whether a user has liked a recipe. The security measure includes checking if the user is authenticated before allowing them to like or unlike a recipe.
- The AddRecipeView view allows authenticated users to add new recipes. Security measures include using LoginRequiredMixin to ensure that only authenticated users can add recipes. It also validates user input using Django forms (AddRecipeForm and AddIngredientForm). The view handles both the recipe and its associated ingredients.
- The UpdateRecipeView view allows authenticated users to update their recipes. It includes security measures such as using LoginRequiredMixin to ensure only authenticated users can update recipes and validating user input using forms (UpdateRecipeForm and AddIngredientForm). It checks if the user trying to update the recipe is the actual owner.
- The DeleteRecipeView view allows authenticated users to delete their recipes. Security measures include using LoginRequiredMixin to ensure only authenticated users can delete recipes. It checks if the user trying to delete the recipe is the actual owner.

Form Validation

ReviewForm and RecipeForm is a basic form, and validation is handled by the default behavior of Django's ModelForm.
AddIngredientForm uses Django form field types to ensure correct data types for name, quantity, and unit. Also, it specifies the available choices for the unit field and u tilizes attributes to control the appearance of form fields. Moreover, it sets specific constraints on the quantity field, limiting it to positive numbers and defining the maximum and minimum values. Uses the max_digits and decimal_places attributes for the quantity field to handle decimal precision. AddRecipeForm and UpdateRecipeForm ensure that the title is unique using a custom clean_title method. Also, they set specific constraints on the prep_time, cook_time, and servings fields, limiting them to positive numbers and defining maximum and minimum values. Furthermore, validate the size of the featured_image to ensure it is no larger than 5 MB. Next, customizes the appearance and behavior of form fields using widget attributes. Finally, the form methods checks for the uniqueness of the recipe title to prevent duplicate entries.

Features

The home page contains a hero section, with the Join Now button, that allows unregistered users to go directly to the sign-up page. Also, the About section lists the main features of the application's future updates and invites users to register.
The application consists of a comprehensive list of recipes.
Users can sign up for an account and log in.
Once logged in, the user can gain access to:
- detailed recipe overview
- add a new recipe
- update own recipes
- delete own recipes
- like the recipes (all - only once, and can change)
- rate the recipes (all - only once, and cannot change)
- leave a review (all, unlimited times)
- print a recipe
User receives feedback upon completion of the above-listed actions.
Average recipe rating is displayed for the user underneath the recipe image.
Total number of likes is displayed for the user underneath the recipe image.
Total number of reviews and approved reviews are displayed for each recipe, for registered users only.

Existing Features

Home Page
- Displays a navigation bar with logo, main heading, hero section, about section, footer with social links.

Once logged in the Join Now button disappers.

Logo
- Logo was also created using Canva software. It is the abbreviation of the Chef's Helper name.
  
  Logo
Navigation Bar differs for visitors, and logged in users.
- Navigation bar for a visitor
  
  Navigation bar for website visitors.
- Navigation bar for a user
  
  Navigation bar for logged in users.
  - Navigation bar for an admin
  Navigation bar for logged in admin.
  
  </detai
About Section
- It contains a description of the main function of the application, and future updates.
  
  About Us Section.
Footer
- The website contains copyright information, creator details, and social links. The website includes links to the creator's LinkedIn and GitHub profiles. These links serve as a means for users to connect with the creator on professional and collaborative platforms.
  
  Footer.
Sign up Page
- The user can sign up by providing a username, and password and repeating the password again. After successful sign-up, the user will be logged in and redirected to the home page.
  
  Sign-up page.
  
  Success message, user logged in after sign-up completed.
Login Page
- Once the user successfully completes signing up for the application, the user can safely log into their own account by providing a username and associated password.
  
  Sign-in page.
Browse Available Recipes
- Visitors, as well as logged-in users, have the ability to browse through our extensive collection of available recipes. The search functionality allows users to find specific recipes by providing either the complete name or a partial name. Each recipe is accompanied by essential information displayed under the recipe image or image placeholder. This information includes the recipe name, the author, the date when the recipe was added or last updated, the number of likes, and the average rating.
- Additionally, when hovering over a recipe, users can access a short description (if provided), offering a glimpse into what makes each recipe special.
  
  Recipes page.
  
  Search results.
  
  Recipe description on hover.
Recipe pagination
- Recipes are displayed in four columns on large screens, two on medium, and one column on small. The application displays up to eight recipes per page.
  
  Recipe pagination.
Logged in User's taskbar
- Authorised users benefit from a handy taskbar to easily print, add, edit and delete recipes.
  
  Recipes page taskbar.
  
  Recipe View page taskbar.
Logout
- Implementing a confirmation modal before logout ensures users consciously confirm their decision, minimizing accidental logouts. This user-friendly step prevents inadvertent actions, particularly in scenarios where logging out may lead to data loss or workflow disruption. The modal prompts users to confirm their logout choice, enhancing overall user experience by adding a deliberate confirmation step.
  
  Logout confirmation modal.
Add a recipe
- Users can create a new recipe by completing all mandatory fields on the "Add Recipe" form.
- To save a recipe, users must fill in all required fields. They have the option to save the recipe as a draft or publish it.
- The recipe title must be unique, and at least one cooking instruction, one ingredient, preparation time, cooking time, and the number of servings must be provided.
- While the recipe description and image are optional, if a user does not provide an image, a standard image placeholder will be inserted.
  
  Add Recipe page.
Edit the recipe
- Users can update their created recipe by filling in all mandatory fields on the "Update Recipe" form.
- Similar to the "Add Recipe" page, users can add or remove additional instructions or ingredients during the update process.
  
  Update Recipe page.
Rate and review recipe
- Users have the flexibility to contribute unlimited reviews for a recipe, fostering the exchange of tips and enabling engaging conversations. The inclusion of a rating system not only aids in identifying popular recipes but also enhances community engagement.
- Ratings are mandatory and submitted alongside the review. Once a user rates a recipe, the rating becomes permanent, and the average rating is automatically recalculated. A confirmation message is provided upon the successful submission of the review.
- Users can easily view the total number of reviews submitted for a recipe. In cases where there are pending reviews awaiting approval, an informational message is displayed to users, keeping them informed about the status of the reviews.
  
  Review and rate recipe.
Like the recipe and average rating.
- Users have the option to express their appreciation for a recipe by clicking on the heart icon beneath the recipe image, toggling between like and unlike. The total number of likes is prominently displayed beside the heart icon.
- Additionally, an average rating score is showcased beside the likes, accompanied by the total number of full-filled golden stars representing the rating. In instances where the average rating is below 0.5, a half-filled golden star is displayed, providing a visual representation of the recipe's overall rating.
  
  Likes and average rating.
Print Recipe
- Logged-in users have the capability to print recipes. The print view omits the review section and action buttons, streamlining the printed output for a focused and convenient recipe reference.
  
  Print recipe.
Delete Recipe
- Users have the ability to delete their own recipes. To mitigate the risk of accidental deletion, users are required to confirm the action before the deletion process is initiated. It's important to note that this action is irreversible, emphasizing the need for careful consideration before proceeding with the deletion.
  
  Delete recipe.
Admin Features
- Django built in admin panel allows admin control over the website.
- Admin can access admin panel through his navigation bar
- Can add, update, delete recipes, ingredients.
- Can approve reviews.
- Can read, add, edit and delete users, email and manage social acccounts.
  
  Admin panel.

Features Left to Implement

I. Feature Left to Implement with the next update:

Shopping List Functionality - Allow users to add ingredients directly to their shopping list from a recipe. Provide an interface for users to manage and view their shopping list.
Cross-Off Steps and Ingredients - Enable users to mark off completed steps and ingredients while following a recipe.
Dynamic Serving Size Adjustment -Allow users to adjust the ingredient quantities for a recipe based on the desired number of servings.
Uploaded Recipe Image Preview - Allow users to upload an image preview for their recipes, enhancing the visual appeal.
Image Cropping - Implement image cropping functionality to enhance control over the appearance of uploaded images.
Allergen Information - Include allergen information for each recipe, ensuring users are aware of potential allergens.
Recipe Categories - Implement a categorization system for recipes, enabling better organization and filtering.
Nutritional Information - Provide detailed nutritional information for each ingredient and the overall recipe.
Saved Ingredients Library - Allow users to save and reuse ingredients, streamlining the recipe creation process.

II. Transformation into Inventory Application:

Supplier Management - Enable users to add and manage suppliers for ingredients.
Ordering System - Implement a system for creating and managing ingredient orders.
Order Tracking - Allow users to send and receive orders, with tracking capabilities.
Stock Management - Provide tools to update and monitor current stock levels.
Data Analytics - Offer data analytics features to highlight stock numbers, usage patterns, and order trends.
Compatibility with POS Applications - Ensure compatibility with popular Point of Sale (POS) applications used by restaurants and takeaways.

By incorporating these features, Chef's Helper will not only enhance the user experience but also position itself as a versatile tool catering to both home cooks and the hospitality sector. The inclusion of advanced inventory management features and compatibility with POS systems will make it a comprehensive solution for the culinary industry.

Technologies Used

Languages Used

Databases Used

ElephantSQL - Postgres database
Cloudinary - Online static file storage

Frameworks Used

Django - Python framework. Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. Built by experienced developers, it takes care of much of the hassle of web development, so you can focus on writing your app without needing to reinvent the wheel. It’s free and open source. (Source: Django)
Bootstrap 5.3 - CSS framework. Bootstrap is a popular open-source front-end framework that provides a collection of tools, styles, and components to simplify the process of designing and building responsive and mobile-first web pages.
jQuery 3.7.1 - jQuery is a fast, small, and feature-rich JavaScript library. It simplifies things like HTML document traversal and manipulation, event handling, and animation for web development. jQuery is open-source and designed to make things like HTML document traversal and manipulation, event handling, and animation much simpler with an easy-to-use API that works across a multitude of browsers. (Source: jQuery)

Programs Used

Github - Used for creating application repository, version control, organising workflow utilising agile functionality of GitHub project, issues and milestones.
Gitpod - Used as a coding environment.
Heroku - Used as the cloud-based platform to deploy the site.
Canva - Used to create logo, and recipe images.
Google Fonts - Used for the typography.
Figma - Used for creation of wireframes.
Lucidchart - Used for creation of ERD.
Am I Responsive - Used for obtaining screenshot of the application on various devices.
Jinja - Templating engine
Compress.png - Used to reduce the size of images.
favicon.io - Used to convert images into icons.
JSHint - Used to validate JavaScript
W3C Markup Validation Service - Used to validate HTML
CSS Validation Service - Used to validate CSS
CI Python Linter - Used to validate Python

Deployment and Local Development

Local Development

How to Fork

To fork the repository, follow the steps below:

Log in to your GitHub.
Navigate to the repository for this project Chef's Helper
In the top right corner of the window, click on the Fork button.
The process will start, and you will see the message confirming the start.

Remember that if you forked the repository, none of the updates made to the source repo would be reflected in your forked repo.

How to Clone

To bring down project for local development, it is possible to clone a repository by following steps below:

Log in(or Sign Up) to GitHub.
Navigate to the repository for this project Chef's Helper
Above the list of files, click the green button Code.
Select Local tab.
Copy to HTTPS code.
In your local IDE open terminal, choose the location where you want to clone the directory.
Type git clone and then paste the URL you copied from GitHub in step 5.
Set up a virtual environment (not required if you are using the Code Institute template and GitPod or Codeanywhere - this will be already set up).
Press Enter to create the clone.
Install packages by running command pip3 install -r requirements.txt

ElephantSQL Database

Login to ElephantSQL PostgreSQL Database.
Click Create New Instance.
Set up your plan:
- give your plan name - commonly project name
- select Tiny Turtle (Free) plan
- you can leave the tags blank
Select the Region and data center near you.
Click Review.
Check your details are correct and then click Create instance.
Return to the ElephantSQL dashboard and click the database name you just created.
In the URL section, click and copy icon to copy the database URL (you will need this for your env.py file)

Cloudinary

Visit Cloudinary and click on Sing Up For Free.
Provide your name, email address and choose a password
For Primary interest, you can choose Programmable Media for image and video API
Optional: edit your assigned cloud name to something more memorable
Click Create Account
Verify your email and you will be brought to the dashboard
On your Cloudinary Dashboard, you can copy your API key.
Add CLOUDINARY_URL to env.py and Heroku app variables. Make sure that env.py is added to .gitignore to not share you security key.

Heroku Deployment

Log into Heroku account or create an account.

Click the "New" button at the top right corner and select "Create New App".
Enter a unique application name
Select your region
Click "Create App"

Prepare enviroment and settings.py

In your workspace (GitPod) create an env.py file and add it to .gitignore

Add the DATABASE_URL value and your chosen SECRET_KEY value to the env.py file.
Update the settings.py file to import the env.py file and add the SECRET-KEY and DATABASE_URL file paths.
See the code sample
```
from pathlib import Path
import os
import dj_database_url
if os.path.isfile('env.py'):
    import env
```

Comment out the original DATABASES variable and add the code below.

See the code sample

# DATABASES = {
#     'default': {
#         'ENGINE': 'django.db.backends.sqlite3',
#         'NAME': BASE_DIR / 'db.sqlite3',
#     }
# }
    
DATABASES = {
    'default': dj_database_url.parse(os.environ.get("DATABASE_URL"))
}

Don't forget to makemigrations and migrate to update your database.
Add the CLOUDINARY_URL to env.py

Add cloudinary to INSTALLED_APPS in settings.py.

See the code sample

INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'cloudinary',
'blog',
]

Add cloudinary to the static files in settings.py

See the code sample

STATICFILES_STORAGE = 'cloudinary_storage.storage.StaticHashedCloudinaryStorage'
STATICFILES_DIRS = [os.path.join(BASE_DIR, 'static')]
STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')
MEDIA_URL = '/media/'
DEFAULT_FILE_STORAGE = 'cloudinary_storage.storage.MediaCloudinaryStorage'

Link the file to the templates directory in Heroku.

Add TEMPLATES_DIR in settings.py

See the code sample

TEMPLATES_DIR = os.path.join(BASE_DIR, 'templates')

Change the templates directory to TEMPLATES_DIR

See the code sample

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [TEMPLATES_DIR],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

Add Heroku to the ALLOWED_HOSTS in settings.py
See the code sample
```
ALLOWED_HOSTS = [
'your-app-name.herokuapp.com/',
]
```
Add the following Config Vars in Heroku:
- SECRET_KEY (Any Django random secret key).
- CLOUDINARY_URL (Insert your Cloudinary API key).
- PORT = 8000.
- DISABLE_COLLECTSTATIC = 1 (temporary and can be removed once static files are created).
- DATABASE_URL (paste ElephantSQL database URL here).
Heroku Additional Files:
- Create requirements.txt
- Create Procfile.
  See the code sample (for gunicorn)
```
web: gunicorn codestar.wsgi
```

Deploy

Before deployment change DEBUG = False in the settings.py, to prevent sharing sensitive information with the public.
Connect to GitHub in the deploy tab on Heroku app, and find your project repository.
At the bottom of the page you can choose Enable Automatic Deploys for automatic deployments or Deploy Branch to deploy manually. Keep in mind that manually deployed branches will need to be re-deployed after each time the GitHub repository is updated.
Click 'Open App' to view the deployed live site.

Site is now live

You can visit the deployed application at Chef's Helper

Testing

Please see TESTING.md for all the detailed testing performed.

References

Docs

Content

Canva - all images for the recipes where created with the software utilising available templates and photos.
Woodland Whispers Retreat - the structure of the readme file.

Acknowledgements

My sincere gratitude goes to my mentor, Mitko Bachvarov, for providing unwavering support and valuable feedback throughout the entire project.
I extend my heartfelt thanks to my college colleagues for their invaluable feedback on the application, which has been instrumental in its development.

obione84 / django-chefs-helper Goto Github PK

django-chefs-helper's Introduction

Chef's Helper

Table of Contents

User Experience (UX)

Project Goals

Agile Methodology

User Stories

Epics

User Stories

Target Audience

First time user

Registered User

Admin user

Design

Color Scheme

Recipe Images

Logo

Typography

Wireframes

Database Scheme

Data Models

User Journey

Security Features

User Authentication

LoginRequiredMixin

CSRF Protection

Custom Views Security Measures

Form Validation

Features

Existing Features

Features Left to Implement

Technologies Used

Languages Used

Databases Used

Frameworks Used

Programs Used

Deployment and Local Development

Local Development

How to Fork

How to Clone

ElephantSQL Database

Cloudinary

Heroku Deployment

Prepare enviroment and settings.py

Deploy

Testing

References

Docs

Content

Acknowledgements

Recommend Projects

Recommend Topics

Recommend Org