README.md

Foodle

Where Deals Become Meals️

A responsive web application for finding nearby deals built with Django and Angular.

🖥 Demo

foodle.cc

🚀 Quick Deploy

To deploy a local instance of foodle simply clone into a python 3+ virtual environment and run

git clone https://github.com/glasgowm148/Foodle.git
pip3.6 install virtualenv
virtualenv -p python3.6 venv
. venv/bin/activate
pip3.6 install -r requirements.txt
./readme/clean.sh (assuming you can run .sh - if not makemigrations)
python populate_foodle.py
python manage.py runserver

Foodle should now be accessible via: 127.0.0.1:8000

🔨 Installation

We have created install, build, test and clean scripts which do most of the work which can be ran with.

./readme/install.sh

./readme/win.bat

Detailed instructions, full descriptions and commands used available in

📚readme/README.md

✨ Releases

• 0.0.9
  • RELEASE : First draft for submission
    • Site builds and serves as expected, currently using bootstrap cards placed above the angular code until we have the angular cards formatted.

⌨️ Development

• Main Priority
  • Angular cards on home
  • Sorting of cards
• Next
  • ng-zoro
  • google sign-in
  • switch email to django or alt
  • switch sqblite to postgreSQL

🤝 Contributing

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as a GitHub issue).

🗂 Directory Structure

• HTML Templates - html files served
• Angular /app - where the angular html/css/ts lives
• foodle - Django home. foodle python files are located here
• media - databased images stored here
• static - custom css, file storage, font, images
• CSS
  • style.css - main style.css used
  • faq.css - main style.css used
  • input.css - main style.css used
  • style.css - main style.css used

☀️ License

MIT

🔗 Ressources and Acknowlegements

Nathan:

For a number of the bootstrap elements, this tutorial was used to understand and start implementing the basics of them https://www.youtube.com/watch?v=9cKsq14Kfsw

Hassan:

Used to assist in implementing the dropdown on the submit form https://stackovverflow.com/questions/31130706/dropdown-in-django-model

Used in implementing the sign in with google elements https://developers.google.com/identity/sign-in/web/sign-in

Used as a base for styling the submit/login/register pages https://bootsnipp.com/snippets/dldxB

Greg:

When researching how to use Google Maps API the following tutorials were very informative https://developers.google.com/maps/documentation/javascript/tutorial https://developers.google.com/maps/documentation/geocoding/intro https://developers.google.com/maps/documentation/geolocation/intro https://developers.google.com/maps/documentation/javascript/directions

Mark:

• MicroBlog - used as base for project skeleton.
• Angular Materials - used in angular buttons
• NG Bootstrap
• Setting up API - Django&Angular connection

Finn:

Adapted for use: https://wsvincent.com/django-contact-form/

Also this: https://docs.djangoproject.com/en/2.1/topics/email/

Adapted to create FAQ page: https://github.com/CodyHouse/faq-template

SMTP email client: https://app.mailjet.com/

❓ Help

Submit any issues to our github

Running the tests

python manage.py test