Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 2.69 KB

README.md

File metadata and controls

98 lines (73 loc) · 2.69 KB
Raw

Admin Hub API

A centralized backend service powering multiple administrative dashboards. Built with ASP.NET Web API and MS SQL Server.

Overview

Admin Hub API serves as the core backend infrastructure for managing multiple administrative dashboards. It provides a unified interface for data management, authentication, and business logic operations across different administrative frontend applications.

Tech Stack

  • Framework: ASP.NET Web API
  • Database: Microsoft SQL Server
  • Authentication: JWT-based authentication
  • Documentation: Swagger/OpenAPI

Features

  • 🔐 Centralized authentication and authorization
  • 🔄 RESTful API endpoints for multiple dashboard operations
  • 📊 Data aggregation and reporting services
  • 🔍 Advanced search and filtering capabilities
  • 📝 Audit logging and activity tracking
  • 🛡️ Role-based access control (RBAC)

Getting Started

Prerequisites

  • .NET 8.0 SDK or later
  • MS SQL Server 2019 or later
  • Visual Studio 2022 (recommended) or VS Code or Intellij Rider

Installation

  1. Clone the repository
git clone https://github.com/design-sparx/admin-hub-api.git
cd admin-hub-api
  1. Update the connection string in appsettings.json
{
  "ConnectionStrings": {
    "DefaultConnection": "Data Source={{PC-NAME}}\\SQLEXPRESS;Initial Catalog={{DB-NAME}};Integrated Security=True;Connect Timeout=30;Encrypt=False;TrustServerCertificate=False;ApplicationIntent=ReadWrite;MultiSubnetFailover=False"
  }
}
  1. Run database migrations
dotnet ef database update
  1. Start the application
dotnet watch run

Project Structure

admin-hub-api/
├── AdminHubApi/
│   ├── Controllers/          
│   ├── Data/         
│   ├── Dtos/        
│   └── Extensions/      
│   └── Helpers/      
│   └── Interfaces/      
│   └── Mappers/       
│   └── Migrations/       
│   └── Models/       
│   └── Repository/       
│   └── Service/       
├── tests/
└── docs/                      # Additional documentation

API Documentation

API documentation is available via Swagger UI at /swagger when running the application in development mode.

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'feat:Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Support

For support and queries, please open an issue in the GitHub repository.