{"id":22769609,"url":"https://github.com/arjunraj77/flask-restaurant-app","last_synced_at":"2025-07-13T02:09:37.037Z","repository":{"id":65263667,"uuid":"582730114","full_name":"ArjunRAj77/Flask-Restaurant-App","owner":"ArjunRAj77","description":"A simple flask application for restaurant that can perform the basic CRUD opertions","archived":false,"fork":false,"pushed_at":"2023-01-15T19:08:51.000Z","size":9034,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T11:31:15.631Z","etag":null,"topics":["api-python","flask-application","intermediate-projects","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArjunRAj77.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-12-27T17:52:31.000Z","updated_at":"2023-01-15T19:09:56.000Z","dependencies_parsed_at":"2023-01-16T01:31:28.598Z","dependency_job_id":null,"html_url":"https://github.com/ArjunRAj77/Flask-Restaurant-App","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ArjunRAj77/Flask-Restaurant-App","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArjunRAj77%2FFlask-Restaurant-App","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArjunRAj77%2FFlask-Restaurant-App/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArjunRAj77%2FFlask-Restaurant-App/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArjunRAj77%2FFlask-Restaurant-App/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArjunRAj77","download_url":"https://codeload.github.com/ArjunRAj77/Flask-Restaurant-App/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArjunRAj77%2FFlask-Restaurant-App/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265080256,"owners_count":23708121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-python","flask-application","intermediate-projects","python3"],"created_at":"2024-12-11T15:12:24.588Z","updated_at":"2025-07-13T02:09:36.997Z","avatar_url":"https://github.com/ArjunRAj77.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flask Restaurant App\nA simple flask application for restaurant that performs the following functions:\n- Sign In/ Sign Up of customers.\n- Converting customers into vendors.\n- Creating inventory items.\n- Placing Order on inventory items.\n- Displaying the complete list of items from the inventory.\n\nEntirely made with python and flask.\n\n# System Requirements\n\n1. Run the following command in command shell :\n    `pip install -r requirements.txt` and make sure that mySQL is installed before the first command.\n## Installation procedure\n\n1. Install mySql and mySQL workbench first. Source : [mySql installation on macOS](https://database.guide/install-mysql-on-a-mac/)\n\n2. Open mySQL server using the following command :\n    `brew services start mysql` and then run the following command :\n    `mysql -uroot`\n3. Create a database name `restaurant` and use it.\n4. Run the `main.py` file for starting the deployment flask application.\n\n## POSTMAN API Call Procedure\n\n### 1. Sign Up API  \nTo make a POST request to the SignUpAPI endpoint using Postman, you would need to configure the following:\n\n- In the URL field, enter the full URL of your endpoint, including the host and port. For example, if your Flask app is running on http://localhost:5000 and the endpoint is /signup, the full URL would be http://localhost:5000/signup.\n\n- In the Headers section, add a key-value pair with the key Content-Type and the value application/json.\n\n- In the Body section, select the raw option, and enter a JSON object containing the required fields for the SignUpRequest schema.\n\n- In Authorization tab, select the type of authorization you want to use, in this case, it is application secret key\n\n- Add the key in the value field of the authorization tab\n\n- Finally, click the Send button to make the POST request.\n\nimage.png\n\n### 2. Login API  \nTo make a POST request to the LoginAPI endpoint using Postman, you would need to configure the following:\n\n- In the URL field, enter the full URL of your endpoint, including the host and port. For example, if your Flask app is running on http://localhost:5000 and the endpoint is /signup, the full URL would be http://localhost:5000/login.\n\n- In the Headers section, add a key-value pair with the key Content-Type and the value application/json.\n\n- In the Body section, select the raw option, and enter a JSON object containing the required fields for the LoginRequest schema.\n\n- In Authorization tab, select the type of authorization you want to use, in this case, it is application secret key\n\n- Add the key in the value field of the authorization tab\n\n- Finally, click the Send button to make the POST request.\n\nimage.png\n\n### 3. Logout API\nTo make a POST request to the LogoutAPI endpoint using Postman, you would need to configure the following:\n\n- In the URL field, enter the full URL of your endpoint, including the host and port. For example, if your Flask app is running on http://localhost:5000 and the endpoint is /signup, the full URL would be http://localhost:5000/logout.\n\n- In the Headers section, add a key-value pair with the key Content-Type and the value application/json.\n\n- In Authorization tab, select the type of authorization you want to use, in this case, it is application secret key\n\n- Add the key in the value field of the authorization tab\n\n- Finally, click the Send button to make the POST request.\n\n### 4. Add Vendor API\n- This API should take “user_id” as a parameter.\n\n### 5. Get Vendors API\n- Only logged-in users can call this API. \n- This should return all the vendor details with their store and item offerings.\n\n### 6. Add Item API\n- This API should be of the following structure\n```\n{   \n    \"item_id\":\"\",\n    \"item_name\":\"\",\n    \"calories_per_gm\":0,\n    \"available_quantity\":0,\n    \"restaurant_name\":\"\",\n    \"unit_price\":0\n}\n```\n\n### 7. List Items API\n- It list all the items in the inventory\n\n### 8. Create Item Order API\n- API for creating an item order \n- input parameters:\n```\n{   \n    \"user_id\":\"\",\n    \"item_id\":\"\",\n    \"quantity\":0\n\n}\n```\n\n### 9. Place Order API\n- Only logged-in customers can place orders.\n- This API should take “order_id” as a parameter.\n\n### 10. List Orders By CustomerAPI\n- Only logged-in users can call this API. \n- This returns all the orders placed by that customer.\n- This should take “customer_id” as a parameter.\n\n### 11. List All Orders API\n- Only the admin can call this API.\n- This API returns all the orders in the orders table.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farjunraj77%2Fflask-restaurant-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farjunraj77%2Fflask-restaurant-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farjunraj77%2Fflask-restaurant-app/lists"}