{"id":22899652,"url":"https://github.com/yashsomalkar/erpbackend","last_synced_at":"2026-05-06T10:37:38.109Z","repository":{"id":266968732,"uuid":"899142183","full_name":"Yashsomalkar/ERPBackend","owner":"Yashsomalkar","description":"The ERP Backend API is built with Flask and MongoDB to manage ERP functionalities like user, vendor, and admin operations. It supports dynamic product and cart management, role-based authentication, and RESTful API endpoints.","archived":false,"fork":false,"pushed_at":"2024-12-20T07:30:15.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T04:38:36.588Z","etag":null,"topics":["bycryt","fask-cors","flask","mongo","mongodb","pyjwt","pymongo","python"],"latest_commit_sha":null,"homepage":"https://github.com/Yashsomalkar/erpflutter","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/Yashsomalkar.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-05T17:41:58.000Z","updated_at":"2024-12-20T07:30:19.000Z","dependencies_parsed_at":"2024-12-07T11:31:57.521Z","dependency_job_id":null,"html_url":"https://github.com/Yashsomalkar/ERPBackend","commit_stats":null,"previous_names":["yashsomalkar/erpbackend"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yashsomalkar%2FERPBackend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yashsomalkar%2FERPBackend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yashsomalkar%2FERPBackend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yashsomalkar%2FERPBackend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yashsomalkar","download_url":"https://codeload.github.com/Yashsomalkar/ERPBackend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246586108,"owners_count":20801026,"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":["bycryt","fask-cors","flask","mongo","mongodb","pyjwt","pymongo","python"],"created_at":"2024-12-14T01:15:23.268Z","updated_at":"2025-10-15T05:40:13.687Z","avatar_url":"https://github.com/Yashsomalkar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# **ERP Backend API Documentation**\n\nThis document outlines the implemented flows, endpoints, and checks for the ERP Backend.\n\n---\n\n## **Overview**\n\nThe ERP backend is designed to manage Users, Vendors, and Admins for an ERP system. The backend uses **Flask**, **MongoDB**, and **JWT authentication** to provide a secure and structured API.\n\n\n---\n## **FLows of all USER, ADMIN, VENDOR\nhttps://github.com/user-attachments/assets/4964cd1a-a363-4cd9-b14b-2748d5432ebf\n\nhttps://github.com/user-attachments/assets/2fef71d4-f7f3-471f-b647-c84f8d1ca2c8\n\nhttps://github.com/user-attachments/assets/e511d91d-b4ea-42c5-be2a-9de28e596a48\n\n---\n\n## **Flows**\n\n### 1. **User Flow**\nUsers can:\n- Register and log in.\n- View vendors and their products.\n- Add products to the cart.\n- Manage their cart (increment, decrement, or remove items).\n- View and update their guest list.\n- Place and view order statuses.\n\n### 2. **Vendor Flow**\nVendors can:\n- Register and log in.\n- Add, update, and delete products.\n- View transactions for their products.\n- Fulfill orders placed by users.\n\n### 3. **Admin Flow**\nAdmins can:\n- Register and log in.\n- Manage users and vendors.\n  - Add, update, and delete users and vendors.\n  - Manage memberships for users and vendors.\n\n---\n\n## **Endpoints**\n\n### **Authentication**\n1. **Register a User**\n   - **Endpoint**: `/api/auth/register`\n   - **Method**: `POST`\n   - **Body**:\n     ```json\n     {\n       \"name\": \"John Doe\",\n       \"email\": \"john.doe@example.com\",\n       \"password\": \"password123\",\n       \"role\": \"user\"\n     }\n     ```\n   - **Response**: `201 Created` with success message.\n   - **Checks**:\n     - Validates unique email.\n     - Hashes password before storing.\n\n2. **Login**\n   - **Endpoint**: `/api/auth/login`\n   - **Method**: `POST`\n   - **Body**:\n     ```json\n     {\n       \"email\": \"john.doe@example.com\",\n       \"password\": \"password123\"\n     }\n     ```\n   - **Response**: `200 OK` with JWT token.\n   - **Checks**:\n     - Validates email and password.\n\n3. **Admin Registration/Login**\n   - **Endpoints**:\n     - **Register**: `/api/auth/register/admin`\n     - **Login**: `/api/auth/login/admin`\n   - **Role**: Must have `\"role\": \"admin\"` in the body for registration.\n\n4. **Vendor Registration/Login**\n   - **Endpoints**:\n     - **Register**: `/api/auth/register/vendor`\n     - **Login**: `/api/auth/login/vendor`\n   - **Role**: Must have `\"role\": \"vendor\"` in the body for registration.\n\n---\n\n### **User**\n1. **View Vendor Products**\n   - **Endpoint**: `/api/user/vendors/\u003ccategory\u003e`\n   - **Method**: `GET`\n   - **Checks**:\n     - Validates JWT for user role.\n     - Filters vendors by category.\n\n2. **Cart Operations**\n   - **Endpoints**:\n     - **Add to Cart**: `/api/user/cart/add`\n     - **Update Cart**: `/api/user/cart/update`\n     - **Clear Cart**: `/api/user/cart/clear`\n   - **Methods**: `POST`\n   - **Body**:\n     ```json\n     {\n       \"product_id\": \"abc123\",\n       \"quantity\": 2\n     }\n     ```\n   - **Checks**:\n     - Validates product existence.\n     - Ensures stock availability.\n\n3. **Guest List**\n   - **Endpoints**:\n     - **Add Guest**: `/api/user/guests/add`\n     - **Update Guest**: `/api/user/guests/update`\n     - **Delete Guest**: `/api/user/guests/delete`\n   - **Methods**: `POST`\n   - **Body**:\n     ```json\n     {\n       \"name\": \"Jane Doe\",\n       \"email\": \"jane.doe@example.com\",\n       \"phone\": \"1234567890\"\n     }\n     ```\n\n4. **Place Order**\n   - **Endpoint**: `/api/user/orders/place`\n   - **Method**: `POST`\n   - **Body**:\n     ```json\n     {\n       \"cart\": [\n         {\"product_id\": \"abc123\", \"quantity\": 2},\n         {\"product_id\": \"def456\", \"quantity\": 1}\n       ]\n     }\n     ```\n\n5. **View Order Status**\n   - **Endpoint**: `/api/user/orders`\n   - **Method**: `GET`\n   - **Checks**:\n     - Validates JWT for user role.\n\n---\n\n### **Vendor**\n1. **Add Product**\n   - **Endpoint**: `/api/vendor/products/add`\n   - **Method**: `POST`\n   - **Body**:\n     ```json\n     {\n       \"name\": \"Buffet Service\",\n       \"price\": 199.99,\n       \"quantity\": 10,\n       \"category\": \"Catering\"\n     }\n     ```\n\n2. **Edit Product**\n   - **Endpoint**: `/api/vendor/products/\u003cproduct_id\u003e/edit`\n   - **Method**: `PUT`\n   - **Checks**:\n     - Ensures product belongs to the vendor.\n\n3. **Delete Product**\n   - **Endpoint**: `/api/vendor/products/\u003cproduct_id\u003e/delete`\n   - **Method**: `DELETE`\n\n4. **View Transactions**\n   - **Endpoint**: `/api/vendor/transactions`\n   - **Method**: `GET`\n\n5. **Fulfill Order**\n   - **Endpoint**: `/api/vendor/orders/\u003corder_id\u003e/fulfill`\n   - **Method**: `PUT`\n\n---\n\n### **Admin**\n1. **Manage Users**\n   - **Endpoints**:\n     - **View Users**: `/api/admin/users`\n     - **Add User**: `/api/admin/users/add`\n     - **Update User**: `/api/admin/users/update`\n     - **Delete User**: `/api/admin/users/delete`\n   - **Methods**: `GET`, `POST`, `PUT`, `DELETE`\n\n2. **Manage Vendors**\n   - **Endpoints**:\n     - **View Vendors**: `/api/admin/vendors`\n     - **Add Vendor**: `/api/admin/vendors/add`\n     - **Update Vendor**: `/api/admin/vendors/update`\n     - **Delete Vendor**: `/api/admin/vendors/delete`\n\n3. **Membership Management**\n   - **Endpoints**:\n     - **Add Membership**: `/api/admin/memberships/add`\n     - **Update Membership**: `/api/admin/memberships/update`\n\n---\n\n## **Authorization Checks**\n- **JWT** is validated for each endpoint.\n- **Role-Specific Authorization**:\n  - Admin-only endpoints are accessible with the `\"admin\"` role.\n  - Vendor-only endpoints are accessible with the `\"vendor\"` role.\n  - User-only endpoints are accessible with the `\"user\"` role.\n\n---\n\n## **Dummy Data for Testing**\n- **User Accounts**:\n  - `john.doe@example.com` (User)\n  - `jane.admin@example.com` (Admin)\n\n- **Vendor Accounts**:\n  - `vendor1@example.com` (Vendor - Catering)\n  - `vendor2@example.com` (Vendor - Florist)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyashsomalkar%2Ferpbackend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyashsomalkar%2Ferpbackend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyashsomalkar%2Ferpbackend/lists"}