Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/justintime50/easypost-tools-ui
Create shipping labels, track, insure, and refund packages all from a simple UI.
https://github.com/justintime50/easypost-tools-ui
api api-client carriers easypost easypost-api labels laravel shipments shipping shipping-api
Last synced: 14 days ago
JSON representation
Create shipping labels, track, insure, and refund packages all from a simple UI.
- Host: GitHub
- URL: https://github.com/justintime50/easypost-tools-ui
- Owner: Justintime50
- License: mit
- Created: 2019-12-03T20:32:38.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-26T15:51:27.000Z (about 2 months ago)
- Last Synced: 2024-10-25T06:48:42.049Z (21 days ago)
- Topics: api, api-client, carriers, easypost, easypost-api, labels, laravel, shipments, shipping, shipping-api
- Language: PHP
- Homepage:
- Size: 4.65 MB
- Stars: 26
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EasyPost Tools UI
Create shipping labels, track, insure, and refund packages all from a simple UI.
[](https://github.com/Justintime50/easypost-tools-ui/actions)
[](https://coveralls.io/github/Justintime50/easypost-tools-ui?branch=main)
[](https://github.com/justintime50/easypost-tools-ui/releases)
[](LICENSE)
## What Can it Do?
The EasyPost Tools UI is a **proof of concept** on how to build a complete shipping solution using the EasyPost API.
- Create & retrieve shipments
- Buy and print labels
- Buy and print envelope stamps
- Refund shipments
- Generate QR codes
- Create and retrieve trackers
- Create and retrieve insurance
- Create and retrieve addresses
- Create and retrieve parcels
- Search for EasyPost objects by ID
- Support multiple users with unique logins and EasyPost API keys
**See the accompanying [EasyPost Tools](https://github.com/Justintime50/easypost-tools) repo for additional tooling not available via the UI.**
## How it Works
The EasyPost API allows you to create shipping labels with some of the biggest parcel carriers in the world. Supply a `from_address`, `to_address`, `parcel`, and preferred shipping rate/method. Print the label, slap it on your package, and drop it off at your carrier's location. That's it!
## Install
```bash
# Copy the env files, edit as needed
cp src/.env-example src/.env && cp .env-example .env
# Run the setup script which will bootstrap all the requirements, spin up the service, and migrate the database
just setup
```
## Usage
Navigate to `easyposttools.localhost`.
Once the project is setup, simply interact with the various links in the app to interact with the API. Create records, retrieve them, and purchase shipping labels all without needing to do the hard work of integrating with an API.
**EasyPost API:** You'll need a test or production API key from [EasyPost's website](https://easypost.com). Create an account and grab the API key you'd like to use. If using your production API key, make sure to setup billing info on your EasyPost account.
### Deploy
```bash
# Deploy the project locally
just run
# Deploy the project in production
just prod
```
## Development
```bash
# Get a comprehensive list of development tools
just --list
```