the-cook-book-group

A free recipe sharing website

Table of content:

1 Project Purpose

2 User Stories

3 UX

4 UI

5 Wireframes

6 Testing

7 Deployment

8 Technologies used

9 Tools

10 Code

Project Purpose

1. To build a full stack site that allows all users to manage a common dataset of shared recipes.
2. To provide an opportunity for the owner to collect all data provided for future use.

User stories

1. As a user, I want to quickly access the detailed instrucitons for any recipe in the group. so that I can cook using the information presented to me.
2. As a user, I want to quickly and easily choose a category whether I am using, adding or editing recipes. so that I can narrow down the type of recipe I am intending to use/aad/edit/delete
3. As a user, I want to add my own reicpes to the group and be able to give a clear presentation of the recipe and instructions for its use so that I can allow friends and family to enjoy the recipe simply and correctly
4. As a user, I want to alter and ammend any of my recipes if I believe it improves the recipe so that I can help the group as a whole improve the recipes
5. As a user, I want to **have a one click solution to analysing the nutritional value of the recipe and have it presented to me in a format that is familiar to me **so that I can allow the other users to make an informed choice about the nutritional value of my recipe
6. As a user, I want to be able to easily navigate back to the home as well as between pages

UX

• The site should have it's features emmidiately accesable to a user
• The user should have easily accesable recipes and be provided with basic instructions for its use
• The users should be able to share their recipes with the group. This will include details of the recipe such as ingredients, cooking time, amount of people it serves, cooking instructions etc.
• The user should be able to add their name to their recipe.
• The user should be able to add their own image of their recipe.
• The user should have the option of having their recipe analysed for it's nutrition and it be added to the recipe
• The user should have the ability to edit or delete all recipes wihtin the group.
• The site should be easily navigated from page to page as it's purpose will be to assist the user in cooking rather then being their main focus of attention
• The site should feel clean, simple and most of all intuative to the user as it will be the central hup for a commen family/friends experience
• The site should be a familar place to return to after the initial intuatively learned experience

UI

• A mobile first approach to design will be used.
• A navbar with the website title as a central feature. A home button to allow easy navigation back to the main page. A dropdown menu with the main options will feature on the the right side
• Three simple and clear buttons in the main body of the landing page will provide easy options for lookin up, adding and editing recipes.
• A footer with basic website information

WIREFRAMES

(See wireframes folder)

TESTING

[link to testing file]

DEPLOYMENT

How to run this project

All deployment tested on the following

HARDWARE

SOFTWARE

technology used

Front-End

• HTML for the base structure of the website
• CSS for adding styles to HTML elements
• MATERIALISE for frameworks
• JQUERY for javascript functionality

Back-End

• FLASK microframework

• FLASK-PYMONGO

• DNSPYTHON

• HERUKO

• PYTHON

• PYMONGO

Tools

• colorpicker.com
• whimsical Wireframes
• Edamam nutritional analysist API

CODE

adapted from:

Fonts

Google fonts wil be used thoughout. The font-familes will be indie flower and pangolin.

Colours

Images

Inspiration

Credits

Please note

Disclaimer