From ef3ed39e350a8b454fbf766d8703429ca76eb363 Mon Sep 17 00:00:00 2001 From: James Walters <33947683+iamjameswalters@users.noreply.github.com> Date: Fri, 11 Feb 2022 13:04:52 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=8A=F0=9F=8E=8A=F0=9F=8E=8A=20It=20is?= =?UTF-8?q?=20done!=20=F0=9F=8E=8A=F0=9F=8E=8A=F0=9F=8E=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f599884..61479ae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,36 @@ -# codecademy-mealwise -A web app to help a restaurant keep track of its inventory throughout the day. Capstone project for Codecademy Django course. +# Mealwise +A web app to help a restaurant keep track of its inventory throughout the day. Capstone project for [Codecademy Django](https://www.codecademy.com/learn/paths/build-python-web-apps-with-django) course. -## Installation +This app uses [Bootstrap 5](https://getbootstrap.com/), [htmx](https://htmx.org/), [_hyperscript](https://hyperscript.org/), [Bokeh](https://bokeh.org/) for the revenue chart, and [django-admin-interface](https://github.com/fabiocaccamo/django-admin-interface). The majority of that was added after completing the requirements for the assignment (v1.0) + +## Try it Out + +Visit [iamjameswalters.pythonanywhere.com](https://iamjameswalters.pythonanywhere.com/) to interact with a live demo of the app. The database should reset nightly. Feel free to create your own account, or use `user: testuser/pass: mealwise`. Without signing in, you can place and delete orders. All the other features require an account. + +## Local Installation After cloning the project, enter the repository and run `poetry install`. This will install all the project's dependencies within a virtual environment. Once that's done, run `poetry shell` to enter that environment, and navigate to the `mealwise/` directory to run `manage.py runserver`. Have fun! 🙂️ +___ +### Image Credits + +This project uses a handful of demo images. These were sourced from [Wikimedia Commons](https://commons.wikimedia.org/)/[Flickr](https://www.flickr.com/) under [Creative Commons](https://creativecommons.org/) licenses. In compliance with the terms of those licenses, here is attribution for the images I used: + +[CC BY-NC 2.0](https://creativecommons.org/licenses/by-nc/2.0/) + * [Fruit salad by Like_the_Grand_Canyon](https://www.flickr.com/photos/like_the_grand_canyon/47835781931) + +[CC BY-SA 2.0](https://creativecommons.org/licenses/by-sa/2.0/) + * [Macaroni and Cheese from Noodles and Company by Bjorn Watland](https://www.flickr.com/photos/bjornwatland/6027750150) + +[CC BY 2.0](https://creativecommons.org/licenses/by/2.0/) + * [Orange and Chocolate Jaffa cake by Marco Verch](https://www.flickr.com/photos/30478819@N08/32670469447) + +[CC BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/deed.en) + * [CountryFriedSteak.jpg by Kimsey0](https://commons.wikimedia.org/wiki/File:CountryFriedSteak.jpg) + +[CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/deed.en) + * [Grilled cheese sandwich on white plate.jpg by Senator2029](https://commons.wikimedia.org/wiki/File:Grilled_cheese_sandwich_on_white_plate.jpg) + +Public Domain + * [Peanut-Butter-Jelly-Sandwich.jpg by Evan-Amos](https://commons.wikimedia.org/wiki/File:Peanut-Butter-Jelly-Sandwich.jpg) + +None of the images were modified. \ No newline at end of file