https://github.com/codbex/codbex-currencies
Currencies Management Module
https://github.com/codbex/codbex-currencies
module
Last synced: 28 days ago
JSON representation
Currencies Management Module
- Host: GitHub
- URL: https://github.com/codbex/codbex-currencies
- Owner: codbex
- License: epl-2.0
- Created: 2022-04-20T06:02:28.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-23T14:45:32.000Z (2 months ago)
- Last Synced: 2026-03-24T10:58:37.290Z (2 months ago)
- Topics: module
- Language: HTML
- Homepage: https://codbex.com
- Size: 4.53 MB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
codbex-currencies
## 📖 Table of Contents
* [🗺️ Entity Data Model (EDM)](#️-entity-data-model-edm)
* [🧩 Core Entities](#-core-entities)
* [🔗 Sample Data Modules](#-sample-data-modules)
* [🐳 Local Development with Docker](#-local-development-with-docker)
## 🗺️ Entity Data Model (EDM)
## 🧩 Core Entities
### Entity: `Currency`
| Field | Type | Details | Description |
|-----------| ---------- |---------------------------| ---------------------------------------- |
| Id | INTEGER | PK, Identity | Unique identifier for the currency. |
| Code | VARCHAR | Length: 3, Unique, Not null | Code of the currency (e.g., USD). |
| Name | VARCHAR | Length: 127, Not null | Name of the currency. |
| Numeric | VARCHAR | Length: 3, Unique, Not null | Numeric code of the currency. |
| Rounding | INTEGER | Not null | Rounding value for the currency. |
| Base | BOOLEAN | Nullable | Indicates if this is the base currency. |
| Rate | DOUBLE | Not null | Exchange rate of the currency. |
| CreatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was created. |
| CreatedBy | VARCHAR | Audit, Length: 20, Nullable | User who created the entry. |
| UpdatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was updated. |
| UpdatedBy | VARCHAR | Audit, Length: 20, Nullable | User who updated the entry. |
### Entity: `CurrencyRate`
| Field | Type | Details | Description |
|-----------| ---------- | --------------------------- | ---------------------------------------- |
| Id | INTEGER | PK, Identity | Unique identifier for the currency rate. |
| Currency | INTEGER | FK, Not null | Foreign key referencing the currency. |
| Date | DATE | Not null | Date of the currency rate. |
| Rate | DOUBLE | Not null | Exchange rate value. |
| CreatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was created. |
| CreatedBy | VARCHAR | Audit, Length: 20, Nullable | User who created the entry. |
| UpdatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was updated. |
| UpdatedBy | VARCHAR | Audit, Length: 20, Nullable | User who updated the entry. |
## 🔗 Sample Data Modules
- [codbex-currencies-data](https://github.com/codbex/codbex-currencies-data)
## 🐳 Local Development with Docker
When running this project inside the codbex Atlas Docker image, you must provide authentication for installing dependencies from GitHub Packages.
1. Create a GitHub Personal Access Token (PAT) with `read:packages` scope.
2. Pass `NPM_TOKEN` to the Docker container:
```
docker run \
-e NPM_TOKEN= \
--rm -p 80:80 \
ghcr.io/codbex/codbex-atlas:latest
```
⚠️ **Notes**
- The `NPM_TOKEN` must be available at container runtime.
- This is required even for public packages hosted on GitHub Packages.
- Never bake the token into the Docker image or commit it to source control.