README.md

Retail Store Management API

This project provides an API for managing stock, pricing, and inventory for a retail store using .NET Core 8, SQL Server, and Ocelot for API Gateway.

Table of Contents

• Overview
• Features
• Prerequisites
• Installation
• Configuration
• Running the Code
• Postman Collection
• Database Script
• Contributing

Overview

This API offers functionalities to manage product restocking, pricing adjustments based on market trends, and inventory optimization using fake data. The project follows best practices, including the use of stored procedures, SOLID principles, and a microservices architecture.

Features

• Smart Restocking Plan
• Clever Pricing Trick
• Inventory Optimization

Prerequisites

• .NET Core 8 SDK
• SQL Server
• Ocelot

Installation

1. Clone the repository:

   git clone https://github.com/Vijay-Kumavat/RetailStore.git

2. Install dependencies:

   dotnet restore

3. Setup SQL Server:

   • Ensure SQL Server is running.
   • Run the database script provided here to set up the database schema and initial data.

Configuration

1. Update appsettings.json: Configure your SQL Server connection string and any other necessary settings in appsettings.json.

   {
     "ConnectionStrings": {
       "DefaultConnection": "Server=your_server;Database=your_database;User Id=your_user;Password=your_password;"
     },
     "Ocelot": {
       "ReRoutes": [
         // Your Ocelot configuration here
       ],
       "GlobalConfiguration": {
         "BaseUrl": "https://localhost:5000"
       }
     }
   }

2. Ocelot Configuration:

   • Configure Ocelot in ocelot.json for API Gateway setup.

Running the Code

1. Build the project:

   dotnet build

2. Run the project:

   dotnet run

Postman Collection

A Postman collection is provided here to test the API endpoints. Import the collection into Postman and use it to interact with the API.

Database Script

The database script for setting up the required tables and initial data is available here. Run this script on your SQL Server to prepare the database.

Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss any changes or improvements.

Additional Information

• Ensure to follow security best practices, including input validation and protection against SQL injection and XSS.
• Design the solution with scalability and maintainability in mind.