https://github.com/cyrix126/mondialrelay
Mondial relay API client
https://github.com/cyrix126/mondialrelay
Last synced: 3 months ago
JSON representation
Mondial relay API client
- Host: GitHub
- URL: https://github.com/cyrix126/mondialrelay
- Owner: Cyrix126
- License: gpl-3.0
- Created: 2024-07-24T06:55:40.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T19:25:44.000Z (6 months ago)
- Last Synced: 2024-11-22T20:24:22.417Z (6 months ago)
- Language: Rust
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MondialRelay-rs
## Status of developmenent
**Work in Progress**
Version 0.1.0 is in a working state, but not yet tested in production.
## About
mondialrelay-rs is a repository to install an API on your server that will interact with Mondial Relay API to allow your API receiving orders to create a shipment and the worker to print the label for an order.
## Objective
To have a modular API not tied to any CMS which is fast and efficient.
Do not fetch the data of relays, let the client do it. The APU retrieve only the id of the relay/locker.
## Features
- create shipment
- store order_id/label url/date
- return tracking id
- provide label url from order id
## Installation
Working installation on most Linux distribution, but not using opt/ or systemd.
```
git clone https://github.com/Cyrix126/mondialrelay
cargo build --release
sudo cp -r api/config /etc/mondialrelay
sudo cp target/release/mondialrelay-api-server /usr/bin
```
You can also create a init system service, like systemd or dinit.
## Usage
After installing setting your config file, you can start mondialrelay-server-api with DEBUG log the first time.
```
RUST_LOG=debug mondialrelay-server-api
```
## Example
## Bug Reporting
Create an issue on github
## Contributing
## Security
## Documentation
## License
GNU GPL v3