Onboarding flow Optional and Mandatory Fields and DB Contract

docs/DB_CONTRACT.md

@@ -0,0 +1,77 @@
+# ChMS - Database Contract
+
+This markdown lists all core database tables and their columns along with its types and constraints for the Church Management System (ChMS).
+
+## 1. users (Authentication)
+
+| Column        | Type      | Notes / Constraints       |
+| ------------- | --------- | ------------------------- |
+| id            | UUID      | PK                        |
+| name          | String    | User's full name          |
+| email         | String    | Unique, indexed           |
+| password      | String    | Hashed                    |
+| has_onboarded | Boolean   | Default: false            |
+| role          | Enum      | member, admin, superadmin |
+| is_active     | Boolean   | Default: true             |
+| created_at    | Timestamp |                           |
+| updated_at    | Timestamp |                           |
+
+## 2. families (Central Unit for families)
+
+| Column        | Type      | Notes / Constraints                |
+| ------------- | --------- | ---------------------------------- |
+| id            | UUID      | PK                                 |
+| user_id       | UUID      | FK -> users                        |
+| primary_phone | String    | Primary contact number             |
+| address       | Text      | House number & street address      |
+| address_info  | Text      | Apt, building, floor - nullable    |
+| city          | Text      | City or Town name                  |
+| pin_code      | Int       | Area pin code                      |
+| status        | Enum      | active, inactive, moved            |
+| family_notes  | Text      | Admin note (only visible to admin) |
+| created_at    | Timestamp |                                    |
+| updated_at    | Timestamp |                                    |
+
+## 3. family_members (Links members to families)
+
+| Column          | Type      | Notes / Constraints      |
+| --------------- | --------- | ------------------------ |
+| id              | UUID      | PK                       |
+| user_id         | UUID      | FK -> users              |
+| family_id       | UUID      | FK -> families           |
+| name            | String    | User's full name         |
+| email           | String    | Unique, indexed          |
+| primary_phone   | String    | Primary contact number   |
+| secondary_phone | String    | Secondary contact number |
+| gender          | Enum      | male, female             |
+| dob             | Date      | Date of Birth            |
+| is_primary      | Boolean   |                          |
+| is_alive        | Boolean   | Default true             |
+| created_at      | Timestamp |                          |
+| updated_at      | Timestamp |                          |
+
+## 4. family_relationship (Links member to member relationships)
+
+| Column            | Type      | Notes / Constraints                      |
+| ----------------- | --------- | ---------------------------------------- |
+| id                | UUID      | PK                                       |
+| family_id         | UUID      | FK -> families                           |
+| member_id         | UUID      | FK -> family_members                     |
+| related_member_id | UUID      | FK -> family_members                     |
+| relationship_type | Enum      | spouse, parent, child, sibling, guardian |
+| started_on        | Date      | marriage date, guardianship start        |
+| ended_on          | Date      | divorce, ended relation                  |
+| created_at        | Timestamp |                                          |
+| updated_at        | Timestamp |                                          |
+
+## 5. auction_dues (Links families to their dues)
+
+| Column          | Type      | Notes / Constraints |
+| --------------- | --------- | ------------------- |
+| id              | UUID      | PK                  |
+| family_id       | UUID      | FK -> families      |
+| auction_held_on | Date      | Date of auction     |
+| due_amount      | Decimal   | Amount to be paid   |
+| due_on          | Date      | Due date            |
+| created_at      | Timestamp |                     |
+| updated_at      | Timestamp |                     |