My Recipe Book

About
User Stories
Features
Data Model
Testing
Technologies Used
Deployment
Credits

About

My Recipe Book is been designed to facilitate keeping all the cooking recipes in one place and with easy access, allowing the site user to access their personal and family recipes safe and in one place. The site also provides the opportunity to being able to discover new recipes.

User Stories

User Site Stories

As a Site User I can register an account so that I can comment and like a past.
As a Site User I can view a list of posts so that I can select one to read.
As a Site User I can view the number of likes on each post so that I can see which ones are the most viral.
As a Site User I can click on a post so that I can read the full text.
As a Site User I can view a paginated list of posts so that I can easily select a post to view.
As a Site User I can leave comments on a post so that I can be involved in the conversation.
As a Site User I can view comments on an individual post so that I can read the conversation.
As a Site User I can create and save my personal recipes so that I have all my recipes in the same place.
As a Site User I can use the "search" bar so that I can easily find recipes I am looking for.

Admin Site Stories

As an admin User I can acces the admin site so that I can create and control the content I wish for my site.
As an admin User I can create draft posts so that I can finish writing or publish the content later.
As an admin User I can create, read, update and delete posts so that I can manage my site content.
As an admin User I can view the number of likes on each post so that I can see which ones are the most viral.
As an admin User I can approve/disapprove comments so that I can filter out objectionable comments.
As an admin User I can see the personal recipes of all the user so I can have an idea how they are using the site.

Features

Existing Features

Navigation Bar: (available through all the pages on the site)
- When not logged in or not registered, the site user can access the registration page, the login page or do a search throughout the site to find different recipes. The page goes back to the Home page when the site logo is clicked.
- When logged in, the site user can access the logout page, the form page to create a recipe and the page where all his/her recipes are stored in "My Recipes".
Footer: (available through all the pages on the site) The site user can access the different social media pages the site has an account with as well as accessing a link to go back to the Home page.

-Home Page: From here the site user can access the list of recipes created by the Site Admin. All the recipes has an image, recipe title, recipe, excerpt to know a little more about the recipe, level of difficulty, cooking time and how many likes it has. If wished the site user can click on "See Recipe" and access all the details for the recipe with all the steps and ingredients needed.

Login/Logout/Register: The site user can register on the site and once registered s/he can log in and logout from the site whenever they want.
Add Recipe: If registered the site user can access the form to create their own personal recipes, which are stored in the backend.
My Recipes: The page holds all the recipes the registered site user has created as a list. From here the recipes can be seen, edited or deleted if wished by the site user.
Admin Site: Can be accessed by adding "/admin" on the browser at the end of the site url. From there the admin user have access to all the users details and their personal recipes, can create content for the site, regulate comments by approving or dismissing them. The information on the site can also be filtered for easy search, among other options.

Future Features

My Calendar: The site user will be able to save the recipes they would like to cook and specify when to organise their weekly meals.
My Shopping List: The site user would be able to create a shopping list based on the recipes they would like to cook during the week and specify the quantities that needs to be bought.
Share personal recipes: The site user would be able to share their personal recipes with the rest of site users after the site admin has reviewed and authorised it.

Wireframes

Below are the initial wireframes for the site for both desktop screens and smaller devices:

Desktop screens

Smaller screens

Data Model

The Entity Relationalship Database (ERD) below was created to develop this project, unfortunately due to time constraint not all the features could be developed.

There are two types of recipes: the ones created by the site user and the ones created byt the site admin. The site admin has CRUD (create, read, update and delete) access to all the recipes through the admin site but the site user only has access CRUD access to their own recipes plus can view the recipes created by the site admin.

In regards of the comments, the site user is able to comment on a particular recipe and submit the comment for the site admin to approve.

The Future Features have been described in the ERD as well.

Testing

Testing is been done manually and have gone through all the features the site provides for all types of screens, from small to desktop screens. All the features responding as expected with the exceptions explained below in Remaining Bugs.

Login/logout/register: the user can use all this features with no errors, pop up messages appearing as well.
Search bar: working and showing all the recipes with the searched words, if search button is clicked a message stating so appears.
Recipe list: a list created from both, site and admin user, appears on their designated html file. All the links are clickable and fully functional ('see reipe', 'edit', 'delete').
Recipe details: the recipes created from both, site and admin user, can be accessed in detail. For the admin user recipes the like button is fully funcitonal and the reicpe can be liked/unliked.
Comments: the comments section in the recipes created by the site admin works as expected, if registered the users can post comments, and the site admin can check those comments and approve them before been public.
Add recipe: if registered, the site user can create their own recipe, see them in a list in "My Recipes", update the content created or delete it.
Navbar and footer: all the links in the footer and navbar working as expected, no broken links.

Remaining Bugs

When creating a recipe (as site user using Add Recipe in the navbar), after clicking the submit button the recipe saves and the pages redirects correctly but it takes a several seconds to do so.
When editing a recipe as a site user the text can be edited, however when attempting to change the image it is not updated. Haven't been able to fix the issue due to submitting time constraints.
On smaller screens, when creating a personal recipe, the column overflows to the left due to the "add image" box option been too large. I have tried to fix it but couldn't due to time constraints. The form is created using crispy forms and created automatically.

Validator Testing

Used PEP8online.com to validate Python code.
User W3C to validate HTML and CSS code

Remaining erros

setting.py
- line too long (for lines 119, 122, 125, 128 and 151): lines can't be cut down to 79 characters because they contain paths and url names.
env.py
- line too long (for lines 3 and 5): lines can't be cut down to 79 characters because they contain url names.
base.html:
- Parse error for tag encountered but could not find a solution for it as I believe it is due to the base.html file loading and creating the error. On the file itself the code seems to be correct. I have searched a solution through the internet and asked through the different course channels but no solution found.

Technologies Used

Deployment

The project is been deployed to Heroku. Steps for deployment:

Deployment to Heroku:
- Create an account in Heroku;
- Create a new app in Heroku: choose a unique name and region;
- Introduce sensitive data needed to be kept secret from the config Var tab in env.py and attach the database (Cloudinary url, Database url and Secret Key);
- Add necessary buildpacks: Python;
- Prepare environment and settings.py file by referencing env.py and link the database variable on Heroku;
- Migarte all the changes;
- Get all static and media files stored in Cloudinary by adding the cloudinary url in env.py and in Heroku, add Cloudinary to settings.py as well as telling Django, link the file to the templates in Heroku and allow Heroku as a host in Allowed_Hosts;
- In Gitpod create the media, static and templates directories;
- Add the project name in Procfile;
- Make deployment commit in the terminal;
- Manually deploy content through Heroku;
- For deployment method, GitHub was selected and confirmed we want to connect to GitHub;
- Connect Heroku to the repository for My Recipe Blog a;
- Set "Enable Automatic Deploys" to allow automatic deployments every time the code is pushed;
- Click on Deploy.
- For final deployment:
  - In settings.py set Default = False;
  - Below add X_FRAME_OPTIONS = 'SAMEORIGIN';
  - Commit and push the changes in the terminal;
  - In Heroku, in the settings tab remove the DISABLE_COLLECTSTATIC variable;
  - In Heroku, go to the deploy tab and click on deploy branch.

Credits

I would like to thank everyone that has supported me during the development of this project. To my family and friends for cheering me up to keep going, to my mentor Chris for guiding me through the requirements and provide me with good tips and advice and to the tutoring team at Code Institute for supporting me troubleshooting and learning how to solve issues appearing on the way.

code-institute-submissions / my-recipe-blog-a Goto Github PK

my-recipe-blog-a's Introduction