https://github.com/engineervix/zed-shipping
A shipping cost calculator for online purchases destined for Zambia
https://github.com/engineervix/zed-shipping
Last synced: 5 months ago
JSON representation
A shipping cost calculator for online purchases destined for Zambia
- Host: GitHub
- URL: https://github.com/engineervix/zed-shipping
- Owner: engineervix
- License: bsd-3-clause
- Created: 2023-06-10T15:07:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T05:43:15.000Z (over 2 years ago)
- Last Synced: 2025-02-04T12:14:26.708Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://zedshipping.pages.dev
- Size: 997 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Zed Shipping Calculator
[](https://github.com/engineervix/zed-shipping/actions/workflows/main.yml)
[](https://nodejs.org/en/blog/release/v22.0.0)
[](https://prettier.io/)
[](http://commitizen.github.io/cz-cli/)
[](http://conventional-changelog.github.io)
[](https://conventionalcommits.org)
This is a small tool that provides instant quotes for both domestic deliveries within Zambia and international shipments originating from the UK.
Built with Vue 3 and Vite, UI powered by PrimeVue and Tailwind CSS.
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Data Source & Disclaimer](#data-source--disclaimer)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Available Scripts](#available-scripts)
## Features
- **Dual Service Modes**: Easily switch between calculating costs for domestic deliveries and international (UK to Zambia) shipments.
- **Volumetric Weight Calculation**: Automatically determines the billable weight by comparing the package's actual weight against its dimensional weight (`L x W x H / 6000`), ensuring accurate pricing.
- **Zone-Based Domestic Pricing**: Implements One World's official pricing structure based on four distinct delivery zones (Lusaka, Line of Rail, Not Line of Rail, and Remote Areas).
- **Detailed Cost Breakdowns**: For heavier packages (over 30kg for domestic, over 10kg for international), the app shows the base rate and additional costs.
- **Dark & Light Mode**: Includes a user-friendly theme toggle that respects system preferences and saves the user's choice.
- **Responsive Interface**: The UI is fully responsive, providing a seamless experience on both desktop and mobile devices.
---
## Tech Stack
- **Framework**: Vue 3 (using Composition API and ``)
- **Build Tool**: Vite
- **UI Components**: PrimeVue 4 with the Aura theme
- **Styling**: Tailwind CSS
- **Utilities**: VueUse
- **Code Quality**: ESLint and Prettier
---
## Data Source & Disclaimer
Please note that this is an **unofficial** calculator. The rates and zone data used in this application are based on the official One World Logistics Service Guide, effective **February 2024**.
This tool is intended for estimation and reference purposes only and is not affiliated with, or endorsed by, One World Logistics. For official quotes and services, please contact One World Logistics directly.
---
## Getting Started
Follow these instructions to get a local copy of the project up and running.
### Prerequisites
You need to have Node.js installed on your machine. The required version is specified in `package.json`.
- **Node.js**: v20 or v22
### Installation
1. Clone the repository to your local machine:
```sh
git clone https://github.com/engineervix/zed-shipping.git
```
2. Navigate into the project directory:
```sh
cd zed-shipping
```
3. Install the required NPM packages:
```sh
npm install
```
---
## Available Scripts
This project includes several scripts to help with development and production workflows:
- **`npm run dev`**
- Starts the Vite development server with Hot-Module Replacement (HMR).
- **`npm run build`**
- Compiles and minifies the application for production into the `dist` directory.
- **`npm run preview`**
- Starts a local server to preview the production build from the `dist` directory.
- **`npm run lint`**
- Lints the project files using ESLint to find and fix problems in your code.
- **`npm run format`**
- Formats all source files in the `src/` directory using Prettier.
## Credits
- **og image**: https://unsplash.com/photos/brown-cardboard-boxes-on-gray-metal-rack-fCyfgmnTj4o