Skip to content

Latest commit

 

History

History
120 lines (95 loc) · 2.33 KB

README.md

File metadata and controls

120 lines (95 loc) · 2.33 KB

Packt Logo

Packt 📦

A modern package tracking platform that lets you monitor all your shipments in one place

Features ✨

  • 🔍 Multi-Carrier Support

    • DHL
    • La Poste
    • Colissimo
    • Chronopost
    • Mondial Relay
    • Asendia
    • FedEx
    • Add your own !

  • 🎯 Easy Tracking

    • Detailed event history
    • Location tracking

  • 🌓 Modern (and beautiful) UI

    • Dark/Light mode
    • Responsive design
    • Clean interface

  • 🔗 Package Sharing

    • Generate share links
    • Import packages from links

  • 💾 Local Storage

    • Offline access
    • No account needed
    • Data persistence

  • 📱 Progressive Web App support

    • Easy install
    • Native-like experience

Setup 🚀

Backend

  1. Edit vars in .dev.vars (or the production version if using on production)
  2. Install and run the backend
cd backend
bun install
bunx wrangler dev

Frontend

1.Change the API_BASE_URL in the page's js 2.Open index.html or serve it.

API Documentation 📚

The backend API provides endpoints for:

  • /api/list - Get list of supported carriers

Response:

[
  {
    "name": "string",
    "icon": "string",
    "requiredFields": ["string"]
  }
]
  • /api/get - Get tracking information

Response:

{
  "trackingNumber": "string",
  "trackingUrl": "string",
  "carrier": "string",
  "status": {
    "code": "string",
    "description": "string",
    "timestamp": "string",
    "location": "string"
  },
  "estimatedDelivery": "string",
  "events": [
    {
      "code": "string",
      "description": "string",
      "timestamp": "string",
      "location": "string"
    }
  ]
}

Contributing 🤝

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License 📄

This project is available under Mozilla Public License 2.0 (MPL-2.0)

Please the license carefully before using this software. If you have any questions about licensing, please open an issue.

Built with ❤️ and 🌊 by Paylicier