KooCook! - Django backend

Build status

• master:
• dev:

Description

KooCook! is a web application that helps people—whether they are amateur cooks, homecooks, aspiring cooks, experienced cooks, or just starving people—decide on what food they want to make with the ingredients, equipment, time, and preferences that they have and live a healthier life with nutrition information included.

This repo is considered a submodule for the main app and act as a backend (backbone) of the project.

Team Members

Name (Nickname)	GitHub ID
Mai (Mai)	MaiMee1 | MaiNorapong
Tharathorn (Mos)	th-bunratta
Chayathon (Plume)	plumest

Local Quickstart (Running the app locally)

Dependency requirements

Name	Required version(s)
Python	3.7.3 or higher
Django	2.1 or higher
PostgreSQL	12 or higher

All other dependencies are specified in requirements.txt

Steps

Proxy installing via virtualenv is highly recommended

Please consult this link to learn how to setup Python virtualenv

1. Make sure you are in the root directory (repository root) of the project and already cloned this repo.

2. Create .env for your local app environment settings (Pending guide...)

   • Make sure your secret key is strong enough. (Recommended: PBKDF2 algorithm with a SHA256 hash)

3. Run pip install -r requirements.txt first to install required packages for the project.

4. If you first set up a repo of the application on a clean slate, migrate the database as well by running the following Django command:

   python manage.py migrate

5. To populate database with data from sites, run command 'scrape'

   python manage.py scrape
   

   with options according to your liking. (--help for more info)

6. Run

   python manage.py runserver

   and, Voila!, the server should listen on the default port at localhost:default_port.

Project Documents

• Iteration Plans (Google Docs)
• Task board (Trello)
• Code Review Script and Checklist (Google Docs)
• Project Proposal (Google Docs)
• Static mockup
  • Screenshots & Demo: Google Drive
  • Source code: GitHub
• Slides

Other Links

• Deployed app:
  • (Production/Development) https://koocook-deploy.appspot.com/ (Active, based on dev branch)
• Project folder (Drive)
  • This includes mockup screenshots and demo as well.
• Main app (GitHub)
• Django backend (GitHub)
• datatrans (GitHub) -- supporting package for data transformation

Notes

About branching

Our team decided to change from using GitHub Flow to Git Flow, so our main branch is dev (mainly for development) and not master (production-only)