Skip to content

Latest commit

 

History

History
61 lines (56 loc) · 2.88 KB

README.md

File metadata and controls

61 lines (56 loc) · 2.88 KB
Raw

Smart Grocery Map and Inventory

Motivation and Project Description

  • In large stores, people often lack a convenient way to find all their goods. Without guidance around the place, shoppers always have to traverse the entire store just to find a small item. Most stores like Walmart or IKEA don't have a detailed map labeling every item or section. With this information missing, it could waste a lot of people's time when they search for multiple items at once.
  • Our platform will help generate an optimal map based on a shopper's e-cart or grocery list that maps out the shortest path to get all their goods.
  • Team boundarybreakers will contribute its skills to create a mobile application that addresses the issue mentioned above.

Installation

Technologies we use include:

  1. Clone this repository to your local machine.

  2. Frontend Setup:

    $ cd code/smart_grocery_map
$ flutter pub get
    • use the recommended simulation device(Name: Pixel_2_API_30, Target: google_apis_playstore [Google Play] (API level 30), hw.lcd.width: 1080, hw.lcd.height: 1920)

  3. Backend Setup:

    • Have Python installed
    • Install Django, Pillow and django-cors-headers
    $ python -m pip install Django
$ python -m pip install Pillow
$ python -m pip install django-cors-headers

  4. Running the app:

    • go into the Django project directory and start the server
    $ cd code/backend/SmartGroceryApp
$ python manage.py runserver
    • go into the Flutter project directory and run the app on emulator
    $ cd code/smart_grocery_map
$ flutter run -d chrome --web-port=3001 lib/main.dart
$ flutter run -d emulator-5554 lib/main.dart

Contribution

Do you use Git Flow?

Yes, we will use the Git Flow model that uses multiple feature and main branches.

What do you name your branches?

  • main branch: containing the current working version
  • develop branch: containing the current developing code that will be merged into the main branch
  • feature-Name branches: containing newly made features branching off the develop branch.

Do you use github issues or another ticketing website?

Github Issues, Discord, and Jira will be used to ticket issues.

Do you use pull requests?

Yes, process described below:

  1. Clone repository from this site and create a new branch.
git checkout https://github.com/UTSCCSCC01/projectf21-team-boundarybreakers -b name_for_new_branch
  1. Change existing functions or add new features.
  2. Test thoroughly.
  3. Submit pull request with a detailed description of changes made.