Bake It 'Til You Make It is a community-based web application for those who love the art of baking, where users can search and share their favourite creations.

Inspired by the old-school baking book (full to the brim with loose paper and notes), the application features hand-drawn graphics and fonts designed to bring the users back to a time of scribbled recipes, in a more organised fashion, through a simplistic and intuitive user interface.

The recipe database encourages users to create an account that will allow them to upload and store their favourite baking recipes as well as find new inspiration from other users, saving their favourites for later.

UX

Project Goals

The primary goal of Bake It 'Til You Make It is to provide a web-based application, that is simplistic and intuitive in design, that allows users to create, search, save and share their favourite baking recipes in one place.

This is the third of four Milestone Projects that the developer must complete during their Full Stack Web Development Program at The Code Institute.

The main requirements were to build a full-stack website allowing users to manage a common dataset (in this instance, baking recipes) using HTML5, CSS3, JavaScript, Python, Flask and MongoDB.

User Goals

The user is looking for:

A searchable database to locate recipes of their choice.
An easy-to-use user management system with CRUD conventions to:
- Create a user account.
- See their user information, as applicable.
- Update (Edit) their user account.
- Delete their user account.
An easy-to-use dataset management system with CRUD conventions to:
- Create recipes.
- Read recipe dashboards.
- Update (Edit) their own recipe creations.
- Delete their own recipe creations.
An intuitive and aesthetically pleasing interface.

Developer / Site Owner Goals

The Developer is looking to:

Create an inviting, community-drive application that they themselves would use to share their passion for baking.
Demonstrate their proficiency in a variety of software development skills, using newly learned languages and libraries as well as a document database system.
Deploy a project they are proud of, and excited to have, on their portfolio.

User Stories

As a General User, I want to:

Intuitively find recipes on the database.
View the selected recipe's dashboard to get necessary information.
Seek contact information to send useful feedback to Developer / Site Owner.

As a Non-Registered User, I want to:

Navigate to Sign-Up page to Register an account.

As a Registered User, I want to:

Log into my account to gain access to the full functionality of the site.
Navigate to my user profile to edit my account information.
Navigate to my account settings to delete my account information.
Navigate to my recipes page to view my uploaded recipes.
Navigate to upload page to add my recipe to the database.
View my own recipe's dashboard to edit recipe as needed.
View my own recipe's dashboard to delete recipe.
Use a save function to save my favourite recipes from other users.
Navigate to my favourites page to view the recipes I have saved from other users.

As an Administrative Account holder, I want to:

View any recipe dashboard to edit recipe as needed.
View any recipe dashboard to delete recipe as needed.
Still maintain a save function to save my favourite recipes from other users.

Development Planes

In order to design and create a web-based interactive application, the developer distinguished the required functionality of the site and how it would answer the user stories, as described above, using the Five Development Planes:

1. Strategy

Broken into three categories, the website will focus on the following target audiences:

Roles:
- Bakers of all levels
- New Users (Non-Registered)
- Returning Users (Registered)
Demographic:
- Passion for baking
- Food lovers
- All ages
Psychographics:
- Personality & Attitudes:
  - Organised
  - Creative
- Values:
  - Community
  - Nostalgia
- Lifestyles:
  - Food interests
  - Outgoing

The website needs to enable the user to:

Register/Login to an account
Edit their account
Delete their account
Search Recipe database by:
- Name/Phrase
- Category
- Level
View Recipe Dashboard with the following information:
- Name
- Image
- Recipe Source
- Description
- Category
- Serving Size
- Time
- Level
- Ingredients
- Directions
Upload and access their own recipes
Save and access their favourite recipes from other users
Get in contact with site owner

The website needs to enable the client to:

Provide a community-driven recipe database
Use the website themselves:
- Share their favourite recipes
- Find new recipes
- Connect with a community that shares their interests
- Have control of the recipes shared
Allow for user feedback and suggestions

With these goals in mind, a strategy table was created to determine the trade-off between importance and viability with the following results:

Strategy Table for User Management:

Strategy Table for Baking Respository Management:

2. Scope

A scope was defined to identify what needed to be done in order to align features with the strategy previously defined. This was broken into two categories:

Content Requirements
- The user will be looking for:
  - Customisable and Editable account:
    - Custom Username/Password
    - Custom User Image
    - Manage their account
    - Upload their own recipes
    - Manage their own recipes
    - Save favourite recipes
  - Easy Navigation
  - Aesthetic and identifiable theme
  - Recipe dashboard:
    - Name
    - Image URL
    - Recipe Source
    - Description
    - Category
    - Serving Size
    - Time
    - Level
    - Ingredients
    - Directions
  - Searchable database system
  - Developer contact information
Functionality Requirements
- The user will be able to:
  - Register/Login to account
  - Customise and edit their profile:
    - Customise Username/Password
    - Customise User Image
    - Edit and Delete their account
    - Upload their own recipes
    - Edit and delete their recipes
    - Save favourite recipes
  - Navigate to recipes:
    - Search by name, category or level
    - My Recipes Page
    - My Favourites Page
  - Create their recipes, providing:
    - Name
    - Image URL
    - Recipe Source
    - Description
    - Category
    - Serving Size
    - Time
    - Level
    - Ingredients
    - Directions
  - Get in contact with the Developer

3. Structure

The information architecture was organized in order to ensure that users could navigate through the site with ease and efficiency, with the following results:

Information Architecture for User Management:

Information Architecture for Baking Respository Management:

4. Skeleton

Wireframe mockups were created in a Figma Workspace with providing a positive user experience in mind:

(Edit Profile and Edit Accounts pages are styled like this in order to remain consistent)

(All modals were styled the same, using their unique content, in order to remain consistent)

Post Mock-Up Design Changes:
While the developer relied heavily on these Wireframes in order to maintain the desired design, there are several differences between the Mockups and the final product:

Most notably, the graphics were changed on the header images for readability purposes to create a better User Experience.
The colouring for the buttons were altered to distinguish their purpose:
- Brown for normal functionality.
- White for 'cancel' actions (return or logout).
- Red for 'danger' actions (delete or alter account and recipes).
A quick-links menu for logged in users, providing them with links to the most used pages:
- Edit Profile
- Create Recipe
- Log Out
A 'breadcrumbs' button was added to the Recipes page, returning the user to their previous page.
Dynamic Ingredients and Directions allowing users to add input fields as needed creating an array for better readability.
The decision was made to hide the disclaimer information by default. Providing users with a button where they can reveal it as they wish.

5. Surface

Colour Scheme
- The chosen colour scheme was specifically selected in order to define the tone of the application.
- Drawing from research conducted on food-related imagery and online sites, a colour palette was developed to create an ambient and familiar environment throughout the site.
- The selected colours are widely used in baking (e.g. in icing and decoration) and, therefore, reflects a sense of nostalgic familiarity.
Typography
- The primary font chosen is Work Sans. A sans-serif typeface, Work Sans is simplistic in design and optimised for screen display, making it easily readable.
- The Secondary font (accent font) chosen is Indie Flower. A handwritten script typeface, it has bubbly, rounded edges to emphasis the homely-handmade recipe book nostalgia.
- The charismatic combination of both handwritten and typed typefaces compliments the soft and familiar theme set by the colour palette and overall appearance of the site while also maintaining readability.
Imagery
- The imagery used was created by the developer using the application Procreate in order to create a consistency of the elements while maintaining the look and feel of the application.
- The background texture effects used were created on Transparent Textures. Each one was customised with the colours set out in the colour palette in order to remain consistent. The following textures were used:
  - The Purty Wood texture was used as the screen background.
  - The Paper 2 texture was used as the background for the 'notebook' effect.
  - The Lined Paper texture was used as the background for the card and image panels.

Back to top ⇧

Data Schema

For this project, the NoSQL database MongoDB was used to store the dataset. Within the created database, four collections were created, as illustrated below:

Users Collection

When registering an account, the user provides:
- Username (unique identifier)
- Email Address
- Password (hashed)
- User Image (not required, default can be used in its place)
The remaining fields (favourite_recipes and is_admin) are provided default values, ensuring that, on registration:
- favourite_recipes array is empty.
- is_admin value is False.
If a user favourites a recipe, that Recipe's id will be included in the favourite_recipes array.

Recipes Collection

When creating a recipe, the user provides:
- Recipe Name
- Recipe Image (not required, default can be used in its place)
- Recipe URL Source (not required, in the event it is not an online recipe)
- Description
- Category
- Difficulty Level
- Serving
- Time
- Ingredients
- Directions
The Ingredients and Directions are arrays, allowing data to be entered dynamically.
The remaining fields (baker and favourite_count) are provided default values, ensuring that:
- baker is automatically the current session user, storing their ObjectId and username.
- favourite_count is empty.
When a user favourites the recipe, the number is incremented.
Similarly, when a user removes the recipe from their favourites, the number is decremented.

Categories Collection

There are four specified categories that the developer chose from researching multiple baking sources.
- Bread
- Cake
- Biscuit
- Pastry
They were selected to refer to a broad spectrum of baking recipes.
Each category has a corresponding icon used throughout to provide visual distinction for each.

Levels Collection

The Recipe's difficulty level is distinguished by:
- Easy
- Medium
- Hard
This was reflective of the user stories, appealing to bakers of all levels.

Features

Design Features

Each page of the website features a consistently responsive and intuitive navigational system:

There is a conventionally placed navbar on the top of each page with easily accessible and identifiable navigation links with a clickable logo, redirecting users back to the home page.
- On mobile and tablet screens, the navbar is located in a conventionally placed 'hamburger' menu.
There is a banner image with title on each page providing users with the necessary feedback of their current position on the site.
- An active class is used in the navbar to provide this feedback as well.
The Footer contains a disclaimer that is hidden, using a toggler function to display the information regarding the use of copyrighted material on the website.
The Footer contains the appropriate icons to allow users to:
- Link to the developers GitHub Page.
- Link to the developers LinkedIn Page.
- Open a Contact Modal to send a message to the Developer.

Jinja was used to extend the base.html page, allowing for the utmost consistency and preservation of functionality across all pages. The extended block elements created the same basic layout for each page:

<nav>
     <!-- Navigational content -->
</nav>

<section>

     {% block header %}
          <!-- Page Banner Image and Title -->
     {% endblock %}

     {% block flash %}
          <!-- Appropriate flash messages -->
     {% endblock %}

     {% block content %}
          <!-- Content unique to each page -->
     {% endblock %}

</section>

<footer>
     <!-- Footer content -->
</footer>

If the user is in session, there will be additional links added to the navbar:
- Edit Profile
- Create Recipe
- Logout
These links allow users to get straight to where they want to be. The additions are broken down as follows:
- On mobile and tablet screens, the extra buttons will appear on the navigation (hamburger) menu in order to provide quick access.
- On larger devices a conventionally placed user_img will appear on the right side of the navigation menu, with a dropdown list of the additional links.
Recipe Cards are used throughout the website, providing users with a snapshot of the recipe and it's information before they view the entire recipe page. Each card is designed the same for consistency purposes and allows the user to either click on the recipe image or name, in order to be directed to the recipe page.

Existing Features

Home Page

Feature	Description
Carousel	Bootstrap Carousel Component that displays the last four uploaded recipes
Call to Action	Buttons connecting users to Sign Up or Login pages, if not signed in, or My Recipes or My Favourites pages, if signed in

Find A Recipe Page

Feature	Description
Search Bar	Search bar function allowing users to search for their preferred recipes. Using a text search will direct users to the `search.html` page, displaying results. From there, they can search again to return.
Dropdown Menu	Nested dropdown menu to refine the users search by either Category or Level
Pagination	The Pagination functionality will be activated once the amount of recipes to be displayed is over `6`. This was to avoid overwhelming the user.

Search Results

Feature	Description
Call to Action	There is a Search Again button allowing users to reset the search. This is conditional. If there is results from their search, the button is placed at the bottom of the page, allowing the users to view their results first. If there is not any results, the button is placed at the top of the page for their convenience (above the recommendations).

Sign Up Page

Feature	Description
Input Fields	The input fields allow users to enter their information. The user can enter a profile image if they wish, or a default image will be used in it's place.
Image Preview	On adding an image url to the `Profile Picture` field, the user can preview their image to ensure that the link is correct and it is the image they would like to use.
Password Authentication	The password field uses Werkzeug to hash the password on entry and confirm password is validated using Javascript. If the passwords do not match, a `disabled` class is added to the Register button, preventing a password error.
Call to Action	Once the input fields are completed as required, the user can click to Register or, if they already have an account, they can Login.

Login Page

Feature	Description
Input Fields	The input fields allow users to enter their username.
Password Authentication	The password field uses Werkzeug to un-hash the password for login authentication
Call to Action	Once the input fields are completed as required, the user can click to Login or, if they do not already have an account, they can Register.

My Recipes Page (This page requires login authentication)

Feature	Description
Call to Action	The User's My Recipes provides multiple actions the user can take: Edit Profile, Create Profile, link to My Favourites and the logout function. If they have no recipes in their repository, the user will be provided with addtional links to get inspired (search recipes) or get creative (create a recipe).

My Favourites Page (This page requires login authentication)

Feature	Description
Call to Action	The User's My Favourites provides multiple actions the user can take: Edit Profile, Create Profile, link to My Recipes and the logout function.

Edit User Page (This page requires login authentication)

Feature	Description
Input Fields	The user is able to edit their profile image as they see fit. Their current information is used as the default value for the fields
Image Preview	The `Profile Image` field allows the user to preview their current profile image. Changing the image url calls a `JavaScript` function, allowing the user to get real-time feedback as they change the image.
Call to Action	The user can choose to Cancel their actions or Save their new information. Both return the user to My Recipes. Another button directs the user to the Account Settings page for user to take further action.

Edit Account Page (This page requires login authentication)

Feature	Description
Input Fields	On this page the user is able to change their password if they wish, their current password is not set as the default value.
Password Authentication	The password field uses Werkzeug to hash the password on entry and confirm password is validated using Javascript, with user feedback. If the passwords do not match, a `disabled` class is added to the Save button, preventing a password error
Call to Action	The user can choose to go Back to the previous page (Edit User) or Save their new information. Another button (Delete Account) opens the `delete_user` modal
Modal	The `delete_user` modal is defensively designed allowing the user to confirm their actions before proceeding with the deletion.

Create Recipe Page (This page requires login authentication)

Feature	Description
Input Fields	The input fields allow the user to input the recipe information as necessary. All fields are appropriately validated, with the exception of `Recipe Image` and `Recipe URL` to allow for the upload of recipes not available online.
Image Preview	Adding to the `Recipe Image` field calls a `JavaScript` function, allowing the user to get real-time feedback of the image.
Dropdown Menu	User can refine their recipe using the dropdown menu
Dynamic Input Fields	The fields for `Ingredients` and `Directions` allow for dynamic input. The user can use the Add Ingredient, Add Direction or Delete buttons to add or remove fields as necessary. This was used in order to create a dynamic array of both lists for a much cleaner and readable display.
Call to Action	As well as the Add Ingredient and Add Direction buttons, there is a Cancel and Add Recipe button, directing the user to their Recipes page.

Edit Recipe Page (This page requires login authentication)

Feature	Description
Input Fields	The input fields allow the user to edit the recipe information as necessary. All fields use the current values as their default, allowing the user to only change the information they need to.
Image Preview	The `Recipe Image` field allows the user to preview their current recipe image. Changing the image url calls a `JavaScript` function, allowing the user to get real-time feedback as they change the image.
Dynamic Input Fields	The fields for `Ingredients` and `Directions` allow for dynamic input. The user can use the Add Ingredient, Add Direction or Delete buttons to add and remove fields as necessary, with the exception of the first in each list, in order to preserve the array.
Call to Action	As well as the Add Ingredient and Add Direction buttons, there is a Cancel and Add Recipe button, directing the user to the appropriate page. A Delete button, opens the `delete_recipe` modal
Modal	The `delete_recipe` modal is defensively designed allowing the user to confirm their actions before proceeding with the deletion.

Recipe Page (Apple Tart Recipe)

The Call to Action buttons on the recipe page are conditional to the user's role on the website, with the following break down:

Role	Conditional Buttons
Not Logged in	Login To Add Favourites - directing the user to login in, in order to save the recipe to their favourites
Logged in user is not author	Add To Favourites - directing the user to add the recipe to their favourites. They are then redirected back to the recipe page with a new Remove from Favourites button.
Logged in user is author	Edit and Delete buttons direct the user to Edit Recipe Page and `delete_recipe` modal respectively.
Logged in user is Admin	The administrative user has access to Edit and Delete buttons as well as the Add To Favourites or Remove from Favourites (should they want to save it)
All Users	A breadcrumb button (powered by `JavaScript`) allows the user to return to their previous page, giving them more control.

Features to Implement in the future

Recipe PDF Download
- A feature that would allow the user to download a PDF copy of the recipe for their own personal records.
- The developer researched the possibilities of this feature, and know it is possible using the pdfkit library import but they held off from implementing it in this release in order to further develop their skills to be able to implement the feature properly. A simplified version could have been implemented but it would not be to the standard the developer would like.
Image Upload
- A feature that would allow the user to upload a file image, rather than using an image url, avoiding the issues they encountered in the validation stages.
- It was on the suggestion of the Code Institute Student Care team that the developer did not implement this feature in this release.
Image Processing
- A feature that would allow for validation of properties on images used.
- The developer did try to implement this feature using Pillow but they were unsuccessful in getting it to work, so it was suggested to them to use the pattern attribute on the image input field in this release.
More Community Capabilities
- A feature that would allow users to share ideas and help other users on the site, creating a more dynamically involved community focus.
- This idea was in the original plans but the developer chose to scale the scope down, excluding this feature, as they knew their present capabilities would not give it the justice the feature deserved.
Email Verification
- A feature that would allow for the developer to send an automated email to users on registration, verifying their email and account.
- This, too, was in the original plans and the developer tried their best to be able to implement it in this release, but it was not meant to be.

Back to top ⇧

Issues and Bugs

The developer encountered a number of issues during the development of the website, with the noteworthy ones listed below, along with solutions or ideas to implement in the future.

Base.html
The base.html page uses Jinja templates in order to extend its components (e.g. page design, navbar & footer) to all other pages. In trying to implement an pseudo active class on the anchor links in the navigation bar, an issue arose where the special state would be applied to all links, not just the active link. It was through a post of a similar problem on Stack Overflow that the developer found a solution, using block elements for each class.

Recipe Cards
The recipe card panel used throughout the website (for consistency) was implemented using the Bootstrap Card Component. Very early into development, the developer noted there was a styling issue with the ul element whereby the li elements nested would not conform to the styling that was needed to be readable. The li elements, due to the Bootstrap styling, would only display in a inline format, which caused padding issues within the card. In order to avoid this, and to maintain the design, the ul was removed and replaced with Bootstrap grid styling. This was done after researching similar issues.

Home Page
The Homepage uses a Bootstrap Carousel feature to highlight the four latest baking recipes added to the database. An issue arose with the carousel whereby only one recipe would be called on repeat. In their endless Google searching, the developer found a helpful article on Stack Overflow that recommended using a loop.index method on the active class of the carousel in order to loop through the latest recipes.

Edit User Page
In order to make the edit_user.html functionality more user-friendly, the developer tried to create a possibility that the user would not have to change their password if they did not wish to (e.g. if they only wanted to change their user image). The problem with this was that should the user leave the password field blank (choosing not to change it), it would automatically change the users password to 'blank' on the database. This was insufficient and in no ways user-friendly, so the developer researched other methods. Their first thought was to use the user's password value as the default value for the field but, as the password is hashed, using werkzeug.security import, this would not work. The alternative, and conclusive, solution was to create a separate accounts settings page, where the user has the freedom to change their password or delete their account.

Password Authentication
The developer encountered a bug in authenticating passwords on both Edit User and Register page. The password and confirm password fields are validated using a JavaScript function to confirm that the values match. The problem with this was that it did not matter to either the Save or the Register button whether the passwords match and so a user could accidentally create a faulty password, losing access to their account. In order to fix this bug, the developer, on the advice of their mentor, created a conditional disabled class for the buttons alongside the JavaScript function, preventing the user submitting a password error.

Pagination
In implementing the pagination functionality, a linting error was raised in the terminal due to the developer using the Pylint extension in their IDE. The message was:

"owner": "python",
"code": "unbalanced-tuple-unpacking",
"severity": 4,
"message": "Possible unbalanced tuple unpacking with sequence defined at line 237 of flask_paginate: left side has 3 label(s), right side has 2 value(s)",
"source": "pylint",
"startLineNumber": 32,
"startColumn": 5,
"endLineNumber": 32,
"endColumn": 5

In order to avoid this error, the developer installed and selected Flake8 to lint through app.py.

Reverted Commits Note
The developer was forced to revert two commits (1 and 2) on the 8th of June in order to backtrack to a previous commit, preserving the functionality that was lost. After trying to implement a partials directory, that would store extendable blocks to be used on all pages, the developer noticed that, in doing so, vital functions, including user authentication were throwing an error. Having already pushed these commits to Github, the developer reverted the commit that implemented the creation of the @login_decorator in app.py, as they believed this to be the cause. Once this was reverted, it was clear that it was not the cause, the commit previous to that (the implementation of the partials directory) was reverted as well. In doing this, the functionality was restored. The developer chose not to re-implement the partials directory but was successful in re-implementing the @login_decorator functionality at a later date.

Back to top ⇧

Technologies Used

Languages

HTML5
CSS3
JavaScript
Python

Tools

Visual Studio Code Insiders
- VSCode was used as the preferred IDE.
Git
- Git was used for version control to commit to Git and push to Heroku.
GitHub
- GitHub was used to store the project repository, after pushing.
Heroku
- Heroku was used in order to deploy the website.
Figma
- Figma was used to create the wireframes during the design phase of the project.
Am I Responsive?
- Am I Responsive was used in order to validate the responsiveness of the design throughout the process, and to generate mockup imagery to be used.
Procreate
- Procreate was used to create and edit images as well as using the colour picker tool to ensure consistency throughout.
Imgbb
- ImgBB was used to externally host images used.
Transparent Textures
- Transparent Textures was used to create the textured background heavily featured on the website.
Font Awesome
- Font Awesome was used in conjunction with Iconify for icons used throughout the website.
Iconify
- Iconify was used in conjunction with Font Awecome for icons used throughout the website.
The developer made the decision to use both websites for icons as neither had all the icons the developer needed to use for UI purposes. Although this may not be best practice, it provided the necessary design functionality for several items, most notably the conditional icons for each category.

Libraries

Bootstrap
- Bootstrap was used to implement the responsiveness of the site, using bootstrap classes.
jQuery
- jQuery was used to simplify the JavaScript code used.
Google Fonts
- Google fonts was used to import the fonts "Indie Flower" and "Work Sans" into the style.css file. These fonts were used throughout the project.
jQuery Validation
- jQuery Validation was used to simplify form validation for the Contact Form.
SweetAlert2
- SweetAlert2 was used to customise the Contact Form success message for UX purposes.
Flask
- Flask was used as the web framework for the application.
PyMongo
- flask_pymongo was used a communication line between the MongoDB database and Python.
Pagination
- flask_paginate extension was used to implement pagination functionality on select pages.
BSON
- bson.objectid is a required dependency for MongoDB management system.
Jinja
- Jinja templating language was used to simplify and display backend data in html.
Werkzeug
- Werkzeug was used for password hashing and authentication.

Database Management

MongoDB
- MongoDB was the chosen NoSQL database for this website.
MongoDB Atlas
- MongoDB Atlas was the cloud database service used to host the database.

Back to top ⇧

Testing

Testing information can be found in a separate testing file

Deployment

To further develop this project, a clone can be made using the following steps:

1. Database Creation

The application is connected to a MongoDB Atlas Cluster. A Project database can be created using the following steps:

Log into MongoDB or create an account.
Locate and select the New Project button on the right side of the page, and give your project a name. Navigate to the project page.
Locate and select the Create a New Cluster button on the right side of the page. Once selected:
- Choose Shared Cluster which is a free option.
- Select your Cloud Provider and Region (in this instance: AWS and Ireland).
- Click on Cluster Tier and select tier of preference (in this instance: Basic M0 tier).
- Click on Cluster Name and create your cluster name.
Locate and select Database Access on the left side of the page. Once selected, click Add New Database User:
- Choose Password for the Authentication Method
- Enter a username and password of your choosing
- Ensure Read and write to any database is selected in Database User Privileges
- Add User
Locate and select Network Access under Database Access on the left side of the page. Once selected, click Add IP Address:
- Select Allow Access from anywhere (This is not recommended for full-production applications).
- Select Confirm.
Locate and select Clusters on the left side of the page (must be provisioned first).
Click Collections, then + Create Database to start adding documents to your database collections:
- Enter chosen Database Name
- Enter chosen Collection Name
- Select Create
Click Create Collection and create the necessary collections. See Data Schema for reference of the collections created for this project.

2. Local Copy Creation

A Local Clone of the repository can be made in two ways:

Forking the Repository:

By forking the GitHub Repository we make a copy of the original repository on our GitHub account to view and/or make changes without affecting the original repository by using the following steps:
1. Log into GitHub or create an account.
2. Locate the GitHub Repository.
3. At the top of the repository, on the right side of the page, select "Fork".
4. You should now have a copy of the original repository in your GitHub account.
Creating a Clone

How to run this project locally:
1. Install the GitPod Browser Extension for Chrome.
2. After installation, restart the browser.
3. Log into GitHub or create an account.
4. Locate the GitHub Repository.
5. Click the green "GitPod" button in the top right corner of the repository. This will trigger a new gitPod workspace to be created from the code in github where you can work locally.
How to run this project within a local IDE, such as VSCode:
1. Log into GitHub or create an account.
2. Locate the GitHub Repository.
3. Under the repository name, click "Clone or download".
4. In the Clone with HTTPs section, copy the clone URL for the repository.
5. In your local IDE open the terminal.
6. Change the current working directory to the location where you want the cloned directory to be made.
7. Type 'git clone', and then paste the URL you copied in Step 3.
```
git clone https://github.com/USERNAME/REPOSITORY
```
1. Press Enter. Your local clone will be created.
(Further reading and troubleshooting on cloning a repository from GitHub here)

Once a local clone is created, the environment variables have to be set:

Create a .gitignore file in the project's root directory.
In the terminal window, type touch env.py to create the file that will contain the environment variables.
Add env.py to the .gitignore file.
Within the env.py file, enter the project's environment variables:

import os

os.environ.setdefault("IP", "0.0.0.0")
os.environ.setdefault("PORT", "5000")
os.environ.setdefault("SECRET_KEY", <your_secret_key>)
os.environ.setdefault("MONGO_URI", "mongodb+srv://<username>:<password>@<cluster_name>-ocous.mongodb.net/<database_name>?retryWrites=true&w=majority" )
os.environ.setdefault("MONGO_DBNAME", <your_mongo_db_name>)

For the MONGO_URI ensure to replace <username>, <password>, <cluster_name> and <database_name> with the appropriate alternatives.

3. Heroku App Creation

The website requires back-end technology, including a server, application and database. It is because of this that the project was deployed on Heroku, a container-based cloud Platform as a Service. There are two ways to deploy on Heroku:

Using the Heroku Command Line Interface
Connect to GitHub Repository (the developer recommends this method)

Before deployment can be carried out on Heroku, the following steps must be carried out:

Create a requirements.txt file to install all requirements. In the terminal window, type the following command:

pip3 install -r requirements.txt

Create a Procfile file so that Heroku knows which file runs the app. In the terminal window, type the following command:

echo web: python app.py > Procfile

Remove the blank line that may occur at the end of the Procfile to avoid any issues

Push the two files to the repository:

git add requirements.txt
git commit -m "Add requirements.txt"

git add Procfile 
git commit -m "Add Procfile"

git push

Once these steps are completed, continue with the process:

Log into Heroku or create an account.
Select the New button on the top-right of the page, and choose Create New App. Give your app a unique name and set the region (in this instance: Europe). Then click Create App.
Navigate to the Deploy tab on the dashboard and select Connect to GitHub.
Search for the repository name (ensuring it is spelled correctly). Once located, click Connect.
Navigate to the Setting tab on the dashboard and select Reveal Config Vars, entering the necessary key/values as below:

Key	Value
IP	0.0.0.0
PORT	5000
SECRET_KEY	`<your_secret_key>`
MONGO_URI	`mongodb+srv://<username>:<password>@<cluster_name>-ocous.mongodb.net/<database_name>?retryWrites=true&w=majority`
MONGO_DBNAME	`<your_mongo_db_name>`

Navigate back to the Deploy tab and scroll down to Automatic Deploys.
Ensure that the master branch is selected, then select Enable Automatic Deploys.

Heroku will receive the pushed code from the GitHub repository and host the application with the required packages set out.

The deployed version can now be viewed by selecting View App in the top-right of the page.

Back to top ⇧

Credits

The developer consulted multiple sites in order to better understand the code they needed to implement their deisgn.

The Code Institute Task Manager Mini Project mini project was used as a reference point for the developer in the development of the core CRUD functionality of the website. The lessons included with the mini-project helped the developer to get a better understanding of each functionality and how to customise it to suit their project.

For code that was copied and edited, the developer made sure to reference this within the code. The following sites were used on a more regular basis:

Stack Overflow
W3Schools
Bootstrap
JSfiddle

Back to top ⇧

Acknowledgements

The developer would like to thank the following:

Fellow CI students, for the inspiration and guidance.
Tim Nelson, for the walkthrough videos on the Code Institute platform.
Their mentor Seun, for her consistent guidance and support.
Their family and friends, for providing a limitless amount of encouragement and suggestions during the entire process of development.

Back to top ⇧

Technical Support

If you encounter any issues with this website, or require any further clarification or support, please email the developer. Thank you!

Back to top ⇧

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Table of contents

UX

Project Goals

User Goals

Developer / Site Owner Goals

User Stories

Development Planes

Data Schema

Users Collection

Recipes Collection

Categories Collection

Levels Collection

Features

Design Features

Existing Features

Features to Implement in the future

Issues and Bugs

Technologies Used

Languages

Tools

Libraries

Database Management

Testing

Deployment

1. Database Creation

2. Local Copy Creation

3. Heroku App Creation

Credits

Acknowledgements

Technical Support

Files

README.md

Latest commit

History

README.md

File metadata and controls

Table of contents

UX

Project Goals

User Goals

Developer / Site Owner Goals

User Stories

Development Planes

Data Schema

Users Collection

Recipes Collection

Categories Collection

Levels Collection

Features

Design Features

Existing Features

Features to Implement in the future

Issues and Bugs

Technologies Used

Languages

Tools

Libraries

Database Management

Testing

Deployment

1. Database Creation

2. Local Copy Creation

3. Heroku App Creation

Credits

Acknowledgements

Technical Support