{"id":18546996,"url":"https://github.com/hk669/goods-rickshaw","last_synced_at":"2026-05-04T07:32:47.457Z","repository":{"id":258700191,"uuid":"871641962","full_name":"Hk669/goods-rickshaw","owner":"Hk669","description":"highly scalable logistics platform that allows users to book transportation services for moving goods with Django","archived":false,"fork":false,"pushed_at":"2024-10-18T14:37:15.000Z","size":78,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T09:34:53.348Z","etag":null,"topics":["channels","django","geospatial","maps-api","real-time","redis-cache","websocket"],"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/Hk669.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-10-12T14:30:16.000Z","updated_at":"2024-12-22T06:37:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"f94541d2-0f89-416c-9077-e4146857251f","html_url":"https://github.com/Hk669/goods-rickshaw","commit_stats":null,"previous_names":["hk669/goods-rickshaw"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hk669%2Fgoods-rickshaw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hk669%2Fgoods-rickshaw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hk669%2Fgoods-rickshaw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hk669%2Fgoods-rickshaw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hk669","download_url":"https://codeload.github.com/Hk669/goods-rickshaw/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254292067,"owners_count":22046427,"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":["channels","django","geospatial","maps-api","real-time","redis-cache","websocket"],"created_at":"2024-11-06T20:27:45.883Z","updated_at":"2026-05-04T07:32:47.411Z","avatar_url":"https://github.com/Hk669.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Logistics Platform ( Goods-RickShaw )\n\nA scalable logistics platform for managing vehicle bookings, real-time tracking, and fleet management. This platform allows users to book transportation services, track vehicles in real-time, and provides a streamlined interface for drivers and admins to manage jobs and analyze fleet performance.\n\n## Table of Contents\n\n- [Features](#features)\n- [Tech Stack](#tech-stack)\n- [Setup and Installation](#setup-and-installation)\n- [Usage](#usage)\n- [Environment Variables](#environment-variables)\n- [Project Structure](#project-structure)\n- [API Endpoints](#api-endpoints)\n- [Deployment](#deployment)\n\n## Features\n\n### User Features:\n- **Booking Service**: Users can book a vehicle for transporting goods by specifying pickup and drop-off locations. The booking includes vehicle type and an estimated cost.\n- **Real-Time Tracking**: Users can track the driver’s location in real-time after booking.\n- **Price Estimation**: Provides an upfront price estimation based on distance, vehicle type, and current demand.\n\n### Driver Features:\n- **Job Assignment**: Drivers can receive and accept booking requests, view pickup and drop-off locations, and update the job status.\n- **Job Status Updates**: Drivers can update job statuses such as en route, goods collected, and delivered.\n\n### Admin Features:\n- **Fleet Management**: Admins can manage vehicles, monitor driver activity, and analyze booking data.\n- **Data Analytics**: Basic analytics to track completed trips, average trip time, and driver performance.\n\n## Tech Stack\n\n- **Backend**: Django (Python)\n- **Frontend**: HTML, CSS, JavaScript (Google Maps API)\n- **Database**: SQLite (for development), PostgreSQL (for production)\n- **APIs**: Google Maps JavaScript API, Google Maps Geocoding API\n- **Deployment**: Docker, Elastic Beanstalk (AWS)\n\n## Setup and Installation\n\n### Prerequisites\n- Python 3.8+\n- Django 4.x\n- Google Maps API Key\n- Docker (optional for deployment)\n\n### Installation\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/Hk669/goods-rickshaw.git\n   cd goods-rickshaw\n   ```\n\n2. Create and activate a virtual environment:\n   ```bash\n   python3 -m venv venv\n   source venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\n   ```\n\n3. Install dependencies:\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n4. Apply migrations:\n   ```bash\n   python manage.py migrate\n   ```\n\n5. Run the server:\n   ```bash\n   python manage.py runserver\n   ```\n\n6. Access the application at `http://127.0.0.1:8000`.\n\n### Docker Setup\n\nTo run the application using Docker:\n\n1. Build and run the services:\n\n```sh\n   docker-compose up --build\n```\n\n2. Access the application at `http://localhost:8000`.\n\n## Usage\n\n### User\n- Users can register, log in, and book a vehicle by providing the pickup and drop-off location using the map interface.\n- Users can track their bookings and view real-time updates on the driver’s location.\n\n### Driver\n- Drivers can log in, view available jobs, and update job statuses (e.g., en route, goods collected, delivered).\n- Drivers' locations are updated periodically using GPS.\n\n### Admin\n- Admins can manage vehicles, track trips, and generate analytics reports from the admin dashboard.\n\n## Environment Variables\n\nTo run this project, you will need to add the following environment variables to your `.env` file:\n\n```\nSECRET_KEY=your_django_secret_key\nDEBUG=True\nALLOWED_HOSTS=localhost,127.0.0.1\nDATABASE_URL=your_database_url  # For PostgreSQL or other databases\nGOOGLE_MAPS_API_KEY=your_google_maps_api_key\n```\n\n## Project Structure\n\n```\ngoods-rickshaw/\n│\n├── bookings/\n│   ├── migrations/\n│   ├── templates/\n│   ├── static/\n│   ├── forms.py\n│   ├── models.py\n│   ├── views.py\n│   ├── urls.py\n│   └── admin.py\n│\n├── drivers/\n│   ├── migrations/\n│   ├── forms.py\n│   ├── models.py\n│   ├── views.py\n│   ├── urls.py\n│   └── admin.py\n│\n├── users/\n│   ├── migrations/\n│   ├── forms.py\n│   ├── models.py\n│   ├── views.py\n│   ├── urls.py\n│   └── admin.py\n│\n├── manage.py\n├── Dockerfile\n├── requirements.txt\n├── README.md\n├── .env\n└── logistics_platform/\n    ├── settings.py\n    ├── urls.py\n    └── wsgi.py\n```\n\n## API Endpoints\n\n### Booking Endpoints\n- **POST** `/bookings/create/`: Create a new booking.\n- **GET** `/bookings/track/\u003cid\u003e/`: Track an existing booking.\n- **POST** `/bookings/update-status/`: Update the status of a booking (driver).\n\n### Driver Endpoints\n- **POST** `/drivers/update-location/`: Update the driver's location.\n- **GET** `/drivers/jobs/`: View available jobs.\n\n### Admin Endpoints\n- **GET** `/admin/dashboard/`: View fleet and booking analytics.\n\n\n## Deployment\n\nTo deploy the application using Docker:\n\n1. Build and run the Docker containers:\n\n```sh\n   docker-compose up --build\n```\n\n2. Access the application at `http://localhost:8000`.\n\n### AWS Elastic Beanstalk Deployment\n\n1. Configure Elastic Beanstalk with the necessary environment variables:\n   `(SECRET_KEY, GOOGLE_MAPS_API_KEY, DATABASE_URL)`.\n\n2. Deploy the application using the eb CLI:\n```sh\n   eb init -p python-3.9 logistics-platform\n   eb create logistics-env\n   eb deploy\n```\n\nEnsure you have set up the necessary permissions and configurations in AWS before deploying.\n\nThanks.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhk669%2Fgoods-rickshaw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhk669%2Fgoods-rickshaw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhk669%2Fgoods-rickshaw/lists"}