{"id":19927411,"url":"https://github.com/alexander784/towing","last_synced_at":"2026-05-10T21:40:37.709Z","repository":{"id":242254133,"uuid":"803176331","full_name":"alexander784/Towing","owner":"alexander784","description":"Car Towing API allows car owners to request towing services by submitting their location information to towing companies","archived":false,"fork":false,"pushed_at":"2024-06-01T15:47:23.000Z","size":88,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-12T00:43:44.381Z","etag":null,"topics":["api","flask","flaskrestx"],"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/alexander784.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-05-20T08:09:01.000Z","updated_at":"2024-06-01T15:49:07.000Z","dependencies_parsed_at":"2024-06-10T18:16:56.073Z","dependency_job_id":null,"html_url":"https://github.com/alexander784/Towing","commit_stats":null,"previous_names":["alexander784/towing"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander784%2FTowing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander784%2FTowing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander784%2FTowing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander784%2FTowing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexander784","download_url":"https://codeload.github.com/alexander784/Towing/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241354997,"owners_count":19949291,"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","flask","flaskrestx"],"created_at":"2024-11-12T22:33:25.586Z","updated_at":"2026-05-10T21:40:32.656Z","avatar_url":"https://github.com/alexander784.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Car Towing API\n\u003cp\u003eCar Towing API allows car owners to request towing services by submitting their location information to towing companies.Car owners can quickly and easily request assistance when their vehicles get stuck.\u003c/p\u003e\n\n\n![Car Towing API](/image.png)\n## Usage\n1. Authentication:  Obtain an API token by authenticating as a car owner. This token will be used to authorize requests to the API. \u003cbr\u003e\n\n2. Submit Location: Once authenticated, submit your location information to request towing services. Include details such as: \u003cbr\u003e\n  * current location \u003cbr\u003e\n  * Model of the Car.\u003cbr\u003e\n  * Color of the car.\u003cbr\u003e\n\n\n 3. \u003cp\u003e Wait for Assistance: After submitting your location, wait for the towing company to respond and dispatch assistance to your location.\u003c/p\u003e\n\n ## API endpoints\n `POST /auth/signup` Register as a user of the API.\u003cbr\u003e\n `POST/auth/login`  Authenticate as a car owner stuck to obtain an API token.\u003cbr\u003e\n `POST/tow/request` Submit your location information to request towing services \u003cbr\u003e\n\n ## Authentication\n\n \u003cp\u003e To authenticate with the Car Towing API, send a POST request to /auth/login with your username and password. Upon successful authentication, you will receive an API token in the response.\u003c/p\u003e\n\nExamples Request:\n\n`POST /auth/login`\u003cbr\u003e\n        {\u003cbr\u003e\n            `\"username\": ``\"your_username\",` \u003cbr\u003e\n            `\"password\": \"your_password\"`\u003cbr\u003e\n        }\n\nExample request:\n{\u003cbr\u003e\n    `\"access_token\": \"your_access_token\"` \u003cbr\u003e\n}\n\u003cp\u003eInclude the obtained access_token in the Authorization header of subsequent requests to authorize access to protected endpoints\u003c/p\u003e\n\n\n## Requesting Towing services\n \u003cp\u003eSend a POST request to `/tow/request`\u003c/p\u003e\n\n `POST/tow/request`\u003cbr\u003e\n  { \u003cbr\u003e\n    `\"location_id\":\"1\"`\u003cbr\u003e\n  }\n\n## Installation\n\nClone the repo to your local machine\u003cbr\u003e\nNavigate to project directory\u003cbr\u003e\nCreate a your preferred virtual environment\u003cbr\u003e\nInstall dependencies\u003cbr\u003e\nRun the App\u003cbr\u003e\nCreate a .env file and generate your secret key\u003cbr\u003e\n\nCreating virtual env \u003cbr\u003e\n`pipenv install pipenv shell`\n\n## License \nDistributed under the MIT License. See LICENSE for more information.\n\n ## Author\n Alexander Nyaga.\n\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexander784%2Ftowing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexander784%2Ftowing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexander784%2Ftowing/lists"}