Livefront Code Challenge

"Code with Certainty, Deliver with Confidence"

Built with the tools and technologies:

🔗 Quick Links

• 📍 Overview
• 👾 Features
• 🚀 Getting Started
  • ☑️ Prerequisites
  • ⚙️ Installation
  • 🤖 Usage
  • 🧪 Testing
• 🔰 Seed Data
• 📌 API Reference
• 📌 Additional Endpoints

---

📍 Overview

This repository showcases my response to a coding challenge presented by Livefront. The task involved developing an API specification for a new referrals feature.

---

👾 Features

	Feature	Summary
⚙️	Architecture	The project uses a microservices architecture, with separate services for web API, database, and other components. The solution file (LiveFrontCodeChallenge.sln) defines the relationships between various components and configurations. Containerization is used through Docker Compose to manage dependencies between services and enable seamless interaction with the database from the web application. Use of NuGet package manager for dependencies
🔩	Code Quality	The project uses a consistent naming convention and follows standard coding practices. C# is the primary language. The codebase includes unit tests, integration tests, as well as architecture tests, which are utilized to establish and maintain code quality standards including design conventions and project dependencies in the CartonCaps.Tests project.
📄	Documentation	The documentation is primarily in Markdown format and covers topics such as installation, usage, and testing. The docker-compose.yml file provides a clear overview of the containerized environment and its dependencies.
🔌	Integrations	NuGet package manager integration for dependencies The project integrates with Docker Compose to enable containerized development and deployment. Integration with the SQL database is established through docker-compose.yml configuration.
🧩	Modularity	The project uses a modular architecture, with separate services with clear relationships between them, promoting modularity and maintainability. The use of containerization through Docker Compose enables the deployment of individual services without affecting others. The project includes separate services for web API, services, and tests, ensuring a clean separation of concerns. The project used the NUnit3 testing framework for test execution.
🧪	Testing	The project contains unit tests, integration tests, and architecture tests to ensure the correctness of the codebase. The use of containerization enables easy deployment and testing of individual services.
⚡️	Performance	High code quality with a mix of C# and JSON files suggests good performance Use of NuGet package manager for dependencies supports performance by allowing efficient management of dependencies Presence of various file types indicates potential for optimization and performance tuning
🛡️	Security	NuGet package manager integration for dependencies suggests good security practices (e.g., dependency management) Presence of configuration files (appsettings.json) indicates some level of security and access control Use of various file types (csproj, cs, json, etc.) suggests potential for secure coding practices

---

🚀 Getting Started

☑️ Prerequisites

Before getting started with LiveFrontCodeChallenge, ensure your runtime environment meets the following requirements:

• Version Control: Git
• Programming Language: CSharp
• Programming Framework: .NET8 SDK
• Package Manager: Nuget
• Container Runtime: Docker Desktop

⚙️ Installation

Install using one of the following methods:

Build from source:

1. Clone the repository:

git clone https://github.com/goeke-m/LiveFrontCodeChallenge.git

2. Navigate to the project directory:

cd ./LiveFrontCodeChallenge

Using nuget  

dotnet restore LiveFrontCodeChallenge.sln

Using docker  

• From the root project directory

docker compose  -f "./docker-compose.yml" -f "./docker-compose.override.yml" -p livefrontcodechallenge build

🤖 Usage

Command Line Interface

Using docker  

HTTPS

This project uses HTTPS for local development. This requires the use of a trusted certificate. Before running the application, the following command will check for an existing certificate or generate a new one.

dotnet dev-certs https --trust

From the root project directory

docker compose  -f "./docker-compose.yml" -f "./docker-compose.override.yml" -p livefrontcodechallenge up --build

• This will start the API and SQL Server containers.
• API Swagger Endpoint: https://localhost:8081/swagger/index.html.
• The API will be available at https://localhost:8081/api/v1/referral.
• The API's liveness can be checked at https://localhost:8081/api/v1/health. A 200 response indicates the API is up and running.

Visual Studio

• Open the solution in Visual Studio
• Ensure the Docker-compose is selected as the Startup Item
• Click the Docker Compose run button
  • This will generate the containers and then open the swagger url afterwards.

🧪 Testing

Run the test suite using the following command:

Command Line Interface

Using nuget  

From the root project directory

dotnet test ./CartonCaps.Tests/CartonCaps.Tests.csproj 

Visual Studio

• Open the solution in Visual Studio
• Build the solution using the build button command
• If the Test Explorer is not open, open it Test -> Test Explorer
• In the Test Explorer click on the 'Run All Tests In View' button

---

🔰 Seed Data

[
    {
        "referee": {
            "firstName": "Marsha",
            "lastName": "Mellow",
            "phoneNumber": "555-908-4836",
            "email": null
        },
        "id": "143c90ed-83c2-4ca7-9c07-24957cfadddf",
        "referralStatus": "Complete",
        "referralCode": "X5YGP01"
    },
    {
        "referee": {
			"firstName": "Gene",
            "lastName": "Pool",
            "phoneNumber": null,
            "email": "genepool@gmail.com"
        },
        "id": "d69171d3-5a79-464b-9ac3-6dc220c07e30",
        "referralStatus": "Pending",
        "referralCode": "X5YGP01"
    },
    {
        "referee": {
            "firstName": "Willie",
            "lastName": "Makeit",
            "phoneNumber": null,
            "email": "williemakeit@gmail.com",
            "referral": null
        },
        "id": "24278723-2248-48da-a6f2-c7ba4056a144",
        "referralStatus": "Complete",
        "referralCode": "X5YGP01"
    }
]

---

📌 API Reference

The Referrals API is built using ASP.NET Core and provides the following functionality:

• Manage referrals, including creating, retrieving, updating, and deleting referrals.
• Manage referees, including creating, retrieving, updating, and deleting referees.
• Retrieve referrals based on various criteria, such as referral code and referral status.

The API uses Entity Framework Core for data access and SQL Server as the database.

The Referrals API provides the following endpoints:

Get Referrals

• Endpoint: GET /api/v1/referral/getreferrals
• Parameters:
  • referralCode (required): The referral code to filter the referrals.
  • referralStatus (optional): The referral status to filter the referrals to a specific status.
• Response: A list of referrals matching the provided criteria.

Get Referral by ID

• Endpoint: GET /api/v1/referral/getreferralbyid/{id}
• Parameters:
  • id (required): The unique identifier of the referral.
• Response: The details of the referral with the specified ID.

Create Referral

• Endpoint: POST /api/v1/referral/createreferral
• Request Body:
  • firstName (required): The first name of the referee.
  • lastName (required): The last name of the referee.
  • phoneNumber: The phone number of the referee. Either phone number or email is required.
  • email : The email of the referee. Either phone number or email is required.
  • referralStatus (optional): The status of the referral. This will default to pending status.
  • referralCode (required): The referral code.
• Response: The details of the created referral.

Update Referral Status

• Endpoint: PATCH /api/v1/referral/updatereferralstatus
• Request Body:
  • referralId (required): The unique identifier of the referral.
  • referralStatus (required): The new status of the referral.
• Response: The updated referral details.

Update Referral

• Endpoint: PUT /api/v1/referral/updatereferral
• Request Body:
  • referralId (required): The unique identifier of the referral.
  • firstName (required): The updated first name of the referee.
  • lastName (required): The updated last name of the referee.
  • phoneNumber (required): The updated phone number of the referee.
  • email (required): The updated email of the referee.
  • referralStatus (required): The updated status of the referral.
  • referralCode (required): The updated referral code.
• Response: The updated referral details.

📌 Additional Endpoints:

• Endpoint: GET /api/v1/health
• Response: 200 Status Code if Api is up and running.

---