https://github.com/soulcodex/deus-cargo-tracker
A cargo tracking service used to perform tracking of goods being transported by DEUS
https://github.com/soulcodex/deus-cargo-tracker
Last synced: 5 months ago
JSON representation
A cargo tracking service used to perform tracking of goods being transported by DEUS
- Host: GitHub
- URL: https://github.com/soulcodex/deus-cargo-tracker
- Owner: soulcodex
- Created: 2025-08-27T18:40:17.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-27T18:42:19.000Z (10 months ago)
- Last Synced: 2025-08-28T03:30:20.459Z (10 months ago)
- Language: Go
- Size: 47.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
📦 DEUS Cargo Tracker 📦
## ⚙️ Requirements
- [Go](https://golang.org/doc/install) `1.24 or earlier`
- [Docker](https://docs.docker.com/get-docker/) or [Orbstack](https://orbstack.dev/download)
- [Just](https://github.com/casey/just#installation)
- [golang-ci lint](https://github.com/golangci/golangci-lint)
- [Moq](https://github.com/matryer/moq)
## 📥 Installation
Clone the repository using Git:
```bash
git clone https://github.com/soulcodex/deus-cargo-tracker.git
```
### ⚙️ Install `just`
The repository uses [`just`](https://github.com/casey/just) for task automation. Install it with:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | sudo bash -s -- --to /usr/local/bin
```
### 📦 Install Tools & Dependencies
To install all project external dependencies and tools, run:
```bash
just install
```
## 🐳 Running using a `docker-compose` stack
To start the cargo tracker component using the **Docker Compose** stack provided, run:
```bash
just up
```
To shut down the stack, use:
```bash
just down
```
## ▶️ Running the cargo tracker component locally
To start the cargo tracker component service in local, execute the following command:
```bash
just run
```
> This executes the `docker-compose.yml` file located in `deployments/docker-compose/`.
## 📃 OpenAPI Documentation
The OpenAPI documentation for the cargo tracker component is available on [api/openapi.yaml](api/openapi.yaml). You
can view it in your browser or use tools like Swagger UI to interact with the API.
## 📁 Project Structure
For a deeper dive into project structure best practices, check out the
**[Go Standard Layout](https://github.com/golang-standards/project-layout)** repository.