Git Product home page Git Product logo

love-sandwhiches-readme-example's Introduction

Love Sandwiches

Love Sandwiches is a command-line based Python program to handle data automation for a sandwich company. Love Sandwiches runs a local market stall, selling a small range of sandwiches. For each market day, the staff pre-make stock to sell. If they sell out of a particular sandwich, the staff make extra for their customers, unsold sandwiches are thrown away at the end of the day.

Love Sandwiches will collect the company’s market day sales data, calculate the surplus for the day, and produce recommendations for the number of each sandwich to make for the next market. The goal is to save the company staff time by automating a repetitive task and help reduce the surplus by better predicting sales for future markets. To achieve this, we will wire up our Python program to interact with a Google Sheet, so that we can push and pull data to and from the spreadsheet.

Mockup

Features

Existing Features

  • The Run Program Button

Featured at the top of the page, this buttons allows the user to run the program

run

  • The Terminal Area

In this section, the program will request the market day sales data from our user, and then check if the data provided is valid. If it isn’t, the data will be requested again. Once the data is confirmed as valid, the rest of the program will run to add the sales data to the sales worksheet, calculate and update the surplus data, calculate the sales averages and make stock recommendations.

terminal

  • The Program Structure

structure

Features Left to Implement

Another feature idea that I can add

Testing

In this section, you need to convince the assessor that you have conducted enough testing to legitimately believe that the site works well. Essentially, in this part you will want to go over all of your project’s features and ensure that they all work as intended, with the project providing an easy and straightforward way for the users to achieve their goals.

In addition, you should mention in this section how your project looks and works on different browsers and screen sizes.

You should also mention in this section any interesting bugs or problems you discovered during your testing, even if you haven't addressed them yet.

If this section grows too long, you may want to split it off into a separate file and link to it from here.

Validator Testing

Unfixed Bugs

Mention of unfixed bugs and why they were not fixed

Deployment

This project has been deployed to Heroku

  • Create a requirements.txt file using the terminal command pip freeze > requirements.txt
  • Create a Procfile with the terminal command echo web: python app.py > Procfile
    • git add and git commit the new requirements and Procfile and then git push the project to GitHub.
  • Navigate over to Heroku
  • Click the "new" button, give the project a name & set the region to Europe.
  • From the Heroku dashboard of your newly created application, click on "Deploy" > "Deployment method" and select GitHub.
  • Confirm the linking of the Heroku app to the correct GitHub repository.
  • In the Heroku dashboard for the application, click on "Settings" > "Reveal Config Vars".
  • Set the config vars accordingly

The live link can be found here - https://love-sandwiches.herokuapp.com/

Credits

  • Inspiration for the site was taken from …

Content

  • The text for the Home page was taken from...
  • Instruction on how to implement Google Sheets was taken from Specific YouTube Tutorial

love-sandwhiches-readme-example's People

Contributors

lucyrush avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.