This is basicly an app to organize your shopping list for your grocesery items.
Basic app fetures:
- Every group or household has its own list.
- Short lists based on the topological order of every store.
- Items can be edited, deleted or added by users.
- Supported store locations can be viewed in maps.
It includes a backend written in Javascript and a flutter andrdoid frontend.
Please read the how to download section if you want to download or use the app.
It really helps young developers to star their project's so please if you find this project interesting , you know what to do!
A node js API .
This basic backend API, is using endpoinds which you can find at the basic requests section of the README.
Basicly the response sents a cookie that the reciptent should save it localy. Every request after login or signup should have a cookie or a headers parameter as the request sent.
Requests use the x-www-form-urlencode body form.
A POST sign up request must contain the unique username , unique email , a password and a group (optional).
A POST login request must contain only username and the password. In the database , before store the password they are actually hashed.
Logout request doesnt require databse conection only deletes the stored cookie.
| Request type | Request API Call | Expencted Response | Authentication | Commends |
|---|---|---|---|---|
| GET | / | "welcome" | NO | see if docker is working |
| GET | /health | { "status":"ok" } | NO | check the health of the API |
| POST | /login | { "username": {username}, "email": {user_email}, "group":{group}, "token": {token} } | NO | if login was succesful the system return this json object also sets up a token given from backend in the cookies senction |
| POST | /signup | { "username": {username}, "email": {user_email}, "group":{group}, "token": {token} } | NO | if signup is successful return this json object also sets up a token given from backend in the cookies senction (automatic login) |
| POST | /logout | " user logout" | YES | succedes only if user is loged out |
| POST | /change-password | "password updated" | ??(under construction) | ?? (under construction) |
| GET | /checkUser | {"username" : {username} } | YES | returns the usernmae if user is logged in |
| POST | /add | "added to database!" | YES | Items are inserted based on the item id , currently items may have duplicate names (not suggested). |
| POST | /edit | "object updated successfully in database!" | YES | Items are also updated based their id . Item name , category and quantity can be changed. |
| POST | /delete | "deleted from the database" | YES | items are deleted based on the their id |
| GET | /market-items | A list of json items like : { "item_name": "cheerios", "category": {item category}, "quantity": {item quantity}, "lastModified": {item last modified}, "_id": {item_id} } | YES | Authentication here is a must since the authentication is used to get the group of the user. |
| GET | /markets | A list of json objects : {"super_market_name": {super_market_name}, "address": {super_market_address}} | YES | Get the markets address and name |
| GET | /super-categories | A list of the large categories that we use to shot the item categories. | YES | |
| GET | /items-shorted/:market | A lists of lists . The items returned shorted based on the topological order which is on the database. | YES | This is basicly the heart of my API. |
This is an app to give my backend a form . To do that a flutter is used . You could see some of the basic utilities above:... root page (no login no signup):
login page :
sign up page :
Items page:
Markets page:
Ordered List based on Market:
Add item:
Profile page:
Support:
You can find the file to download here.
Propably you have to accept unkown sources to install it to your android phone.
After installation you should see this icon to your phone.
Opening the app you should be able to see the root page.
Please make a account and fill in a 1 to 10 characters as your group-name. After successfully signing up you are able to see the app.
If you want to see your groupname again got to the profile app.
If you want to contact me for anything you are to do so in the support.
All the other tabs are pretty easy to find on your own.
This readme will be updated often. I will try to solve every issue.