diff --git a/README.md b/README.md index 92991ec..131c033 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,32 @@ -# codbex-number-generator -Number Generator for Documents +# codbex-number-generator -## Local Development with Docker +## πŸ“– 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) + +![model](images/model.png) + +## 🧩 Core Entities + +### Entity: `Number` + +| Field | Type | Details | Description | +|--------| -------- | --------------------------- | ---------------------------------------- | +| Id | INTEGER | PK, Identity | Unique identifier for the number. | +| Type | VARCHAR | Length: 50, Unique, Not Null | Type of the number. | +| Prefix | VARCHAR | Length: 20, Unique, Not Null | Prefix for the number. | +| Length | INTEGER | Nullable | Length of the number. | +| Value | INTEGER | Nullable | Value of the number. | + +## πŸ”— Sample Data Modules + +- [codbex-number-generator-data](https://github.com/codbex/codbex-number-generator-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. diff --git a/images/model.png b/images/model.png new file mode 100644 index 0000000..0147493 Binary files /dev/null and b/images/model.png differ