rahul8320 / formulaoneapi

Dotnet Web Api using MediatR pattern

Project Title

FormulaOne API

Table of Contents

• About
• Getting Started
• Usage

About

FormulaOne API is implemented using the MediatR pattern. It provides functionalities for managing Formula One drivers and achievements.

Getting Started

These instructions will help you set up the project on your local machine for development and testing purposes.

Prerequisites

Ensure you have the following installed:

• .NET 6 or higher (preferably .NET 8)
• .NET EF tools for migrations and database updates
• Your preferred code editor (VSCode is recommended)

Installation

Follow these steps to get the development environment running:

1. Clone the Git repository:

   git clone https://github.com/Rahul8320/FormulaOneApi
   

2. Restore packages:

   dotnet restore
   

3. Build the project:

   dotnet build
   

4. Run the project:

   dotnet watch run
   

   or

   dotnet run
   

Usage

After running the project, access the Swagger page for an intuitive interface to interact with the application. Through Swagger, you can:

• Create a new driver or achievement.
• View a list of drivers or their achievements.
• Update driver or achievement details.
• Add logs for error or update events.

The Swagger page streamlines the process of managing drivers and achievements, making it easy and efficient to perform these tasks.