Skip to content

kera-cudmore/love-sandwiches

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Love Sandwiches Banner Image

Love Sandwiches

Love Sandwiches was created as part of a walkthough project on the Code Institutes Level 5 Diploma in Web Application Development.

GitHub last commit GitHub contributors GitHub language count GitHub top language

CONTENTS


User Stories

This project was created for a sandwich shop to be able to work out how many sandwiches to create for their next market based on their sales and surplus data from their previous markets.


Logic Flow Chart

Love Sandwiches Logic Flow Chart


Technologies Used

Languages Used

  • Python3

Frameworks, Libraries & Programs Used

  • Git - For version control.

  • Github - To save and store the files for the website.

  • Shields.io To add badges to the README.

  • Lucid.app To create the logic flow diagram.

  • Tiny PNG To compress images used in the readme.

  • Google API's were used to enable me to access and update the Google Sheets.


Local Development

How to Fork

To fork the repository:

  1. Log in (or sign up) to Github.
  2. Go to the repository for this project, Love Sandwiches Repo.
  3. Click the Fork button in the top right corner.

How to Clone

To clone the repository:

  1. Log in (or sign up) to GitHub.
  2. Go to the repository for this project, Love Sandwiches Repo.
  3. Click on the code button, select whether you would like to clone with HTTPS, SSH or GitHub CLI and copy the link shown.
  4. Open the terminal in your code editor and change the current working directory to the location you want to use for the cloned directory.
  5. Type 'git clone' into the terminal and then paste the link you copied in step 3. Press enter.

Testing

Testing was carried out throughout the build of the project by utilising print statements to ensure the project was running as envisioned.

The code was also run through PEP8 a python code validator.

PEP8 testing for run.py file


Credits

  • The Love Sandwiches Google Sheet was provided by the Code Institute.