https://github.com/panda4817/mysouschef

CS50 Web programming in Python and JavaScript final project.
https://github.com/panda4817/mysouschef

database django heroku postgresql python3 recipes travis

Last synced: 15 days ago
JSON representation

CS50 Web programming in Python and JavaScript final project.

• Host: GitHub
• URL: https://github.com/panda4817/mysouschef
• Owner: Panda4817
• License: mit
• Created: 2020-06-04T10:34:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-17T10:36:31.000Z (about 1 year ago)
• Last Synced: 2023-11-17T11:38:21.611Z (about 1 year ago)
• Topics: database, django, heroku, postgresql, python3, recipes, travis
• Language: HTML
• Homepage:
• Size: 5.35 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MySousChef

For my CS50 Web programming final project I created a website called MySousChef that lets you search for recipes, add your own recipes, add items to a virtual pantry and keep track of use by dates, best before dates, when a jar was opened and use within data. The website also lets you search for recipes by filtering for ingredients only in your virtual pantry. You can also create a vitual shopping list.

This website is deployed using PythonAnywhere:

[python anywhere link](http://mysouschef.eu.pythonanywhere.com/)

## This project uses

- Python 3.10 Django 3.2 framework

- SQL database (tested with both prostgres and mysql)

- Javascript

- HTML

- SCSS and CSS, using a colorlib template

- Spoonacular API

- Deployed on PythonAnyWhere

- CI/CD using travis

- Database caching

This project is broken down into 2 django apps working together: accounts and recipes.

## Main project folder

Here I have the gitignore file (used to exclude files from git version control), travis.yml (used to build my project in travis when changes are commited), manage.py (Django file to run django commands), requirments.txt (file containing names of all dependencies), procfile (Used by heroku to deploy application) and this README file.

## Static directory

In this folder you will find all javascript files, scss files and css file.

## mysouschef directory

In this folder you will find init.py, settings.py (this includes all settings to do with caching, database, email and static files), urls.py, asgi.py and wsgi.py (files to do with deployment).

## accounts directory

This folder contains all the files for the accounts app. This includes: templates, migrations, admin.py, forms.py, models.py, signals.py, tests.py, tokens.py, urls.py and views.py.

This app lets the user register for an account, activate account by clciking on a link sent by email, login, logout, complete a contact form that emails the form content to admin, change password, change email or change username.

## recipes directory

This folder contains all the files for the recipes app. This includes: templates, migrations, custom templatetags, admin.py, forms.py, models.py, signals.py, tests.py, urls.py, utils.py and views.py.

This app lets you put items in a virtual pantry, create a shopping list, search recipes using the spoonacular api and save them, create own recipes and save them  and finally render a personalised dashboard.