Talabat API Project

Overview

A scalable e-commerce platform built with modern architectural patterns and best practices. This platform leverages Entity Framework, LINQ, and follows Clean Architecture principles to provide a robust solution for e-commerce needs.

Architecture

The project is structured into the following layers:

src/
├── Talabat.APIs/           # API controllers and presentation layer
├── Talabat.Core/           # Domain entities, interfaces, business logic
├── Talabat.Repository/     # Data access implementation
├── Talabat.Services/       # Business services implementation

Project Structure Explanation

• Talabat.APIs: Contains API controllers, filters, and configuration
• Talabat.Core: Houses domain entities, interfaces, and core business logic
• Talabat.Repository: Implements data access patterns and database operations
• Talabat.Services: Contains business service implementations and external integrations

Features

• Onion Architecture: Separation of concerns and maintainability.
• Repository Pattern: Abstraction of the data access layer and consistent interface for querying the database.
• Unit of Work Pattern: Management of the context and transaction of the Entity Framework.
• Specification Pattern: Building complex queries in a composable and maintainable way.
• Stripe Payment Gateway: Integration with Stripe for payment processing.

Getting Started

Prerequisites

• .NET 6.0 SDK
• Docker and Docker Compose
• Visual Studio 2022 or VS Code

Running with Docker

1. Clone the repository:

   git clone https://github.com/Mo7ammedd/Talabat-APIs.git
   cd Talabat-APIs

2. Build and run the containers:

   docker-compose up --build

This will start:

• Talabat API on port 8080
• Redis on port 6379
• SQL Server on port 1433

Local Development

1. Update the connection strings in appsettings.json:

   {
     "ConnectionStrings": {
       "DefaultConnection": "Server=localhost;Database=TalabatDb;User=sa;Password=YourStrong!Passw0rd;",
       "IdentityConnection": "Server=localhost;Database=TalabatIdentity;User Id=sa;Password=YourStrong!Passw0rd;"
     },
     "Redis": {
       "ConnectionString": "localhost:6379"
     },
     "Jwt": {
       "SecretKey": "7f98e3b1-4b7b-4b7b-8b7b-7b7b7b7b7b7b",
       "ValidIssuer": "https://localhost:7284/",
       "ValidAudience": "Mohammed-Mostafa-Apis-Client",
       "TokenLifeTime": 60
     }
      "StripeSettings": {
     "PublishableKey": "",
     "SecretKey": ""
    }
   }

2. Run the application:

   dotnet restore
   dotnet run --project Talabat.APIs

API Documentation

• API documentation available at https://localhost:7284/swagger/index.html
• Detailed endpoint documentation in the Talabat.APIs project
• Postman documentation available here

Development Workflow

1. Make changes to the code
2. Build the Docker image: docker-compose build
3. Run the containers: docker-compose up
4. Access the API at http://localhost:8080

Endpoints

AccountController

• POST /api/account/login: Login a user
• POST /api/account/register: Register a new user
• GET /api/account: Get the current user
• GET /api/account/address: Get the user's address
• PUT /api/account/address: Update the user's address
• GET /api/account/emailexists: Check if an email exists
• PUT /api/account/update: Update the user's information
• PUT /api/account/updatepassword: Update the user's password

BasketController

• GET /api/basket: Get a basket by ID
• POST /api/basket: Update a basket
• DELETE /api/basket/id: Delete a basket by ID

ErrorsController

• GET /errors/{code}: Handle errors

OrderController

• POST /api/order: Create a new order
• GET /api/order: Get orders for the current user
• GET /api/order/{id}: Get an order by ID
• GET /api/order/deliveryMethods: Get delivery methods

ProductsController

• GET /api/products: Get a list of products
• GET /api/products/{id}: Get a product by ID
• GET /api/products/brands: Get a list of product brands
• GET /api/products/categories: Get a list of product categories

Testing

# Run unit tests
dotnet test

# Run the application with Docker
docker-compose up

Monitoring and Logging

• Health checks available at /health
• Logs are written to console and can be viewed using docker-compose logs

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a pull request

License

This project is licensed under the MIT License.

Support

For support, please create an issue in the repository.