[FEAT] Database Setup - Models, and Seeding

[Micah-Shallom]

Description

Set up a database management system for our golang project using GORM. The task includes configuring the database connection, creating entity classes, and seeding the database with initial data. This setup will help streamline data operations and ensure application can interact with the database efficiently.

Tasks

Database Configuration

• Configure the application to connect to a PostgreSQL database using gorm.

• Allow the setup to be flexible for configuring any database.

• Create app.env and add appropriate database credentials (USERNAME, PASSWORD, DB_NAME)

• Change MIGRATE in app.env to true

Entity Classes

Create table structs for User, Profile, Organisation, and Product.

Define relationships between entities:

A user has one profile (https://github.com/OnetoOne). A user has many products (@OneToMany). A user belongs to many organisations (@manytomany). An organisation has many users (@manytomany).

Seeding the Database

• Create a data seeding component to initialize the database with sample data.

• Ensure the seeding process runs only once during application startup.

• Seed the database with the following data:

  • At least 2 users.
  • At least 2 products per user.
  • At least 3 organisations.
  • User one belongs to 2 of the organisations.
  • User two belongs to all 3 organisations.

Validation Steps

• Ensure the following tables and constraints are created:
  • Users
  • Profiles
  • Organisations
  • Products
• Validate the relationships:
  • A user has one profile.
  • A user has many products.
  • A user belongs to many organisations.
  • An organisation has many users.

Api Endoint

• implement the endpoint
  • [GET] api/v1/users/:user_id
  • Sample Response

{
    "status": "success",
    "code": 200,
    "data": {
        "id": "0190ceb8-c4d8-7843-8ab3-916dde3633b3",
        "name": "John Doe",
        "email": "john@example.com",
        "profile": {
            "profile_id": "0190ceb8-c4d8-7844-bd6f-45cb8e60eae8",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "1234567890",
            "avatar_url": "http://example.com/avatar.jpg",
            "user_id": "0190ceb8-c4d8-7843-8ab3-916dde3633b3",
            "created_at": "2024-07-20T06:58:53.921069+01:00",
            "updated_at": "2024-07-20T06:58:53.921069+01:00"
        },
        "organisations": [
            {
                "id": "0190ceb8-c4d8-784b-83d0-8cb4787eaf49",
                "name": "Org1",
                "description": "Description1",
                "users": null,
                "created_at": "2024-07-20T06:58:53.932198+01:00",
                "updated_at": "2024-07-20T06:58:53.932198+01:00"
            },
            {
                "id": "0190ceb8-c4d8-784c-a831-461d6be50ba0",
                "name": "Org2",
                "description": "Description2",
                "users": null,
                "created_at": "2024-07-20T06:58:53.934652+01:00",
                "updated_at": "2024-07-20T06:58:53.934652+01:00"
            }
        ],
        "products": [
            {
                "product_id": "0190ceb8-c4d8-7845-af93-0c2b71af59da",
                "name": "Product1",
                "description": "Description1",
                "owner_id": "0190ceb8-c4d8-7843-8ab3-916dde3633b3",
                "created_at": "2024-07-20T06:58:53.924903+01:00",
                "updated_at": "2024-07-20T06:58:53.924903+01:00"
            },
            {
                "product_id": "0190ceb8-c4d8-7846-862f-aafc4aed3cd4",
                "name": "Product2",
                "description": "Description2",
                "owner_id": "0190ceb8-c4d8-7843-8ab3-916dde3633b3",
                "created_at": "2024-07-20T06:58:53.924903+01:00",
                "updated_at": "2024-07-20T06:58:53.924903+01:00"
            }
        ],
        "created_at": "2024-07-20T06:58:53.919147+01:00",
        "updated_at": "2024-07-20T06:58:53.936264+01:00"
    }
}

• [GET] api/v1/users/:user_id
• Sample Response

  {
  "status": "success",
  "code": 200,
  "data": {
      "id": "0190ceb8-c4d8-7847-b507-1e037c62165c",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "profile": {
          "profile_id": "0190ceb8-c4d8-7848-b6d7-bd9127722ffa",
          "first_name": "Jane",
          "last_name": "Doe",
          "phone": "0987654321",
          "avatar_url": "http://example.com/avatar2.jpg",
          "user_id": "0190ceb8-c4d8-7847-b507-1e037c62165c",
          "created_at": "2024-07-20T06:58:53.931095+01:00",
          "updated_at": "2024-07-20T06:58:53.931095+01:00"
      },
      "organisations": [
          {
              "id": "0190ceb8-c4d8-784b-83d0-8cb4787eaf49",
              "name": "Org1",
              "description": "Description1",
              "users": null,
              "created_at": "2024-07-20T06:58:53.932198+01:00",
              "updated_at": "2024-07-20T06:58:53.932198+01:00"
          },
          {
              "id": "0190ceb8-c4d8-784c-a831-461d6be50ba0",
              "name": "Org2",
              "description": "Description2",
              "users": null,
              "created_at": "2024-07-20T06:58:53.934652+01:00",
              "updated_at": "2024-07-20T06:58:53.934652+01:00"
          },
          {
              "id": "0190ceb8-c4d8-784d-b85a-c157f6f455a7",
              "name": "Org3",
              "description": "Description3",
              "users": null,
              "created_at": "2024-07-20T06:58:53.935722+01:00",
              "updated_at": "2024-07-20T06:58:53.935722+01:00"
          }
      ],
      "products": [
          {
              "product_id": "0190ceb8-c4d8-7849-b7f7-cfa49b0d0208",
              "name": "Product3",
              "description": "Description3",
              "owner_id": "0190ceb8-c4d8-7847-b507-1e037c62165c",
              "created_at": "2024-07-20T06:58:53.931301+01:00",
              "updated_at": "2024-07-20T06:58:53.931301+01:00"
          },
          {
              "product_id": "0190ceb8-c4d8-784a-bb5f-c5c820834d0b",
              "name": "Product4",
              "description": "Description4",
              "owner_id": "0190ceb8-c4d8-7847-b507-1e037c62165c",
              "created_at": "2024-07-20T06:58:53.931301+01:00",
              "updated_at": "2024-07-20T06:58:53.931301+01:00"
          }
      ],
      "created_at": "2024-07-20T06:58:53.930585+01:00",
      "updated_at": "2024-07-20T06:58:53.94121+01:00"
  }
  }

• Invalid User ID
• [GET] api/v1/users/:user_id
• Sample Response

  {
  "status": "error",
  "code": 404,
  "message": "user id does not exist",
  "error": {}
  }

Testing

• Verify the database connection and entity mappings by running the application.
• Ensure data is correctly seeded into the database.
• Validate the relationships and data integrity.

  Acceptance Criteria:

• The application should successfully connect to the PostgreSQL database.
• Entity classes should accurately represent the database schema.
• The database should be seeded with initial data upon application startup.
• All configurations and code should follow best practices and be well-documented.
• The database schema should include the required tables and relationships.
• The seeded data should meet the specified criteria.

[Micah-Shallom]

@NwokoyeChigozie

[Micah-Shallom]

@NwokoyeChigozie modifications made to database setup