{"id":16735602,"url":"https://github.com/pateash/appointy-hackathon","last_synced_at":"2026-05-20T09:11:23.858Z","repository":{"id":111811953,"uuid":"98681093","full_name":"pateash/appointy-hackathon","owner":"pateash","description":"Winner eCommerse API For Appointy-hackathon","archived":false,"fork":false,"pushed_at":"2017-07-29T21:46:24.000Z","size":304,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-01-22T10:12:23.082Z","etag":null,"topics":["api","ecommerce","hackathon","laravel","laravel-5"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/pateash.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":"2017-07-28T19:26:56.000Z","updated_at":"2022-11-25T12:27:19.000Z","dependencies_parsed_at":"2023-05-24T21:15:54.108Z","dependency_job_id":null,"html_url":"https://github.com/pateash/appointy-hackathon","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pateash%2Fappointy-hackathon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pateash%2Fappointy-hackathon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pateash%2Fappointy-hackathon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pateash%2Fappointy-hackathon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pateash","download_url":"https://codeload.github.com/pateash/appointy-hackathon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243790999,"owners_count":20348385,"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","ecommerce","hackathon","laravel","laravel-5"],"created_at":"2024-10-13T00:06:38.895Z","updated_at":"2026-05-20T09:11:18.790Z","avatar_url":"https://github.com/pateash.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cspan align='center'\u003e\n\u003cimg width='250px' src=\"https://appointy.com/creditoffer/Images/Appointy-logo.png\"\u003e\u003c/p\u003e\n\u003cimg width='300px' src=\"http://www.aptusdatalabs.com/wp-content/uploads/2016/04/hackathon-logo.jpg\"\u003e\u003c/p\u003e\n\n\u003c/span\u003e\n\n## About API\n\nThis API provides Ecommerce 'Order return' Functionality. \n\n- Simple, fast routing and dependency injection with [Laravel](https://laravel.com/docs/routing).\n- Based on Rest API Guidelines\n- Automatic Migrations for Models \n\n## Built With\n\u003ca href='//laravel.com'\u003e\u003cimg width='300px' src=\"https://camo.githubusercontent.com/5ceadc94fd40688144b193fd8ece2b805d79ca9b/68747470733a2f2f6c61726176656c2e636f6d2f6173736574732f696d672f636f6d706f6e656e74732f6c6f676f2d6c61726176656c2e737667\"\u003e\u003c/a\u003e\n\n## Install and Run\n- clone project\n- install composer dependencies using `composer install` (of course you need, php and composer\n- create `.env` file by copying from `.env.example`\n- run `php artisan key:generate` command, this will get APP_KEY in `.env` file\n- create database and fill information in `.env' file\n- now run migrations for creating table `php artisan migrate` \n- you will need to  seed your database , use following command steps\n    - run `php artisan tinker` to enter in to command line tinker\n    - enter `factory(App\\User::class,100)-\u003ecreate()`, this will seed your `User` table with 100 records \n    - enter `factory(App\\Order::class,100)-\u003ecreate()`, this will seed your `Order` table with 100 records \n    - enter `factory(App\\Agent::class,10)-\u003ecreate()`, this will seed your `Agent` table with 10 records \n    \n- Now run `php artisan serve`, which will run your app on `localhost:8000`.\n- That's It, You can modify and create a pull request, Thanks.\n\n\u003eRemember Initially, all agents are free and return Orders are zero.\n\n## API Documentation\n\n#### Welcome Page\n\u003e`  GET / ` will take you to the Welcome Page. where you will get same documentation.\n\n#### User \n\u003e Every thing about Users\n \n| API Route      | Functionality  |\n| ------------- |:-------------:| \n| GET /users    |   All Registered Users   | \n| GET /user/{userId}     | User Detail      | \n| GET /user/{userId}/orders     | All Orders By User      | \n\n#### Order \n \u003eEvery thing about Simple Orders (not return orders)\n as we are assuming some orders has been placed and delivered)\n \n| API Route      | Functionality  |\n| ------------- |:-------------:| \n| GET /orders    |   All Delivered Orders   | \n| GET /order/{orderId}     | Order Details      | \n| GET /order/{orderId}/agent     | Agent who has Delivered Order      | \n\u003eHere agent is person who has delivered order ( not the one who will be picking it for return)\n\n#### Return Orders \n \u003eEvery thing about Return Orders ( which will be assigned to free or nearest Agent) \n \n| API Route      | Functionality  |\n| ------------- |:-------------:| \n| GET /returns    |   All Return Placed Orders   | \n| GET /return/{returnId}     | Return Order Details      | \n| GET /return/place/{orderId}     | Place Order with \u003corderId\u003e for return      | \n| GET /return/complete/{orderId}     | Return has been SuccessFull      | \n\u003eHere agent is person who has delivered order ( not the one who will be picking it for return)\n\n#### Agent \n\u003e Every thing about Delivery Agent\n \n| API Route      | Functionality  |\n| ------------- |:-------------:| \n| GET /agents    |   All Registered Agents   | \n| GET /agent/{agentId}     | Agent Detail      | \n| GET /agent/{agentId}/orders     | All Orders Delivered By Agent      | \n| GET /agents/free     | All Free Agents (with no assigned order)       | \n| GET /agents/busy     | All Busy Agents (with assigned order/orders)       | \n\n## Bugs and Fixes\n\nEvery thing anyone create has bugs and some of them can be fixed, If you find one,\nplease mail me at [ashishpatel0720@gmail.com](mailto:ashishpatel@gmail.com)\n\n## License\n\nThis API is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpateash%2Fappointy-hackathon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpateash%2Fappointy-hackathon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpateash%2Fappointy-hackathon/lists"}