Intelligent Shopping List – Summary

## INEZ - Smart Shopping List
To keep this program as small as possible and to improve efficiency,
this program *only* corrects food products because it was made for Edeka,
where mainly food is sold. This program should also work offline,
since it was built on Javascript. This program was written in just 2 days,
the data used was collected and analyzed in 3 days.
I've only been able to spend 4 hours a day with it, because I work and study at the same time, but I can count on the program to run really well.
This README file is written as Markdown .md, for optimal readability, please use a markdown reader. Because this program was written to Javascript, its speed and efficiency can be influenced by the computer used for testing. With PHP and a good server, parsing should take much less than 1 second. With Javascript it can take up to exactly one second or less - this influence depends on the computer. Due to the fact that I did not have that much time, a few norms were neglected, for example user input verification, but they should not be a major problem because the data does not end up on any server.

**Before you start reading**
Qualifier and quantity description are words that describe a quantity better, for example Kg, liter, glass, bottle

**Features*
1. Auto-correction
2. Autosuggest
3. Long term Saving
4. Replace with synonyms

**To run the program,**
1. Upload the whole files to a server,
2. start index.html

## Creation and data models
Unfortunately, there is no public API for food.
To create this program and get the necessary data,
1. I created a crawler
2. Crawled about 300 pages on delicious.de
3. all ingredients according to recipe
4. extracted with regular expressions qualifications.
5. And write a lot of products with my hands

## Algorithms
The intelligent shopping list works with many algorithms.
Visit the links to learn more.

**The algorithm i wrote*
1. The algorithm for recognizing qualifiers
2. The algorithm for parsing products from sentences

**Public*
1. The auto-correction algorithm of Norvig
https://norvig.com/spell-correct.html,
2. Autocorrection algorithm of Willsen
https://github.com/WillSen/spellchecker-autocorrect
3. Dexi Computer Bots and Spiders
Digital Commerce Intelligence – Dexi.io

4. the Dexie database storage plugin (Dexie.org)
https://dexie.org
5. Jquery - for frontend editing
https://jquery.org
6. Logo from PlaceIt
https://placeit.net/logo-maker

## working step
The program works mainly in 4 steps
1. It checks the Sentence written bz the user
a) Is the shopping article written in the normal form?
50 kg of rice
b) is the article in a tailored form without a space
50 liters of water
c) Absolute form without quantity description
50 bananas

2. checks the qualifier (the quantity description)
a) Is the qualifier a valid and the right qualifier?
eg Kg must not be used for liquids
b) Is it written correctly?
for example, Kiolters instead of kiloliters

3. Checks the product and suggests the right qualifications
if incorrect e.g 1 kg of beans

4. Check synonyms
5. Display result
6. Wait for a confirmation from the user with a click
7. Store in the index database

## files
1. Autocorrect.Javascript
This file contains functions for the auto-correction algorithms
2. core.Javascript
This file contains Javascript functions for the frontend
3. css.css
Css styling file
4. dbcontroller.Javascript
Functions for saving and reading a purchase list
5. index.html
Frontend HTML
6. ingredient.Javascript
contains a collection of kitchen products
7. readme.md
Declaration on the progress of the program
8. realdatalist.Javascript
List of some products and the right qualifier
9. synonym.Javascript
List of synonyms for specific products
10. libs /
Contains all public libraries like jquery, dexie and bootstrap.