Merge pull request #1 from osisdie/ci/new

osisdie · web-flow · commit e4415887cdaa · 2026-03-20T09:42:56.000+08:00
Add GitHub community essentials for repo visibility
diff --git a/.env.example b/.env.example
@@ -0,0 +1,17 @@
+# ASP.NET Core
+ASPNETCORE_ENVIRONMENT=Development
+
+# SDK API Configuration
+SDK__ApiKey=
+SDK__ServiceName=
+
+# Redis (optional)
+# REDIS__ConnectionString=
+
+# MySQL (optional)
+# MYSQL__ConnectionString=
+
+# AWS (optional)
+# AWS__AccessKey=
+# AWS__SecretKey=
+# AWS__Region=us-west-2
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,29 @@
+---
+name: Bug Report
+about: Report a bug to help us improve
+title: "[Bug] "
+labels: bug
+assignees: ""
+---
+
+## Description
+A clear and concise description of the bug.
+
+## Steps to Reproduce
+1.
+2.
+3.
+
+## Expected Behavior
+What you expected to happen.
+
+## Actual Behavior
+What actually happened.
+
+## Environment
+- OS: [e.g., Windows 11, Ubuntu 22.04]
+- .NET SDK Version: [e.g., 8.0.100]
+- Module: [e.g., Caching, Auth, Http]
+
+## Additional Context
+Add any other context, logs, or screenshots here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,39 @@
+---
+name: Feature Request
+about: Suggest a new feature or improvement
+title: "[Feature] "
+labels: enhancement
+assignees: ""
+---
+
+## Summary
+A clear and concise description of the feature you'd like.
+
+## Module
+Which module does this relate to?
+- [ ] Abstractions
+- [ ] Auth
+- [ ] Caching
+- [ ] Common
+- [ ] Configuration
+- [ ] DataAccess
+- [ ] Extensions
+- [ ] Hosting
+- [ ] Http
+- [ ] Location
+- [ ] Logging
+- [ ] Measurement
+- [ ] MessageQueue
+- [ ] Notification
+- [ ] ServiceNode
+- [ ] Storage
+- [ ] New module
+
+## Use Case
+Describe the problem this feature would solve or the use case it enables.
+
+## Proposed Solution
+How you think this could be implemented (optional).
+
+## Alternatives Considered
+Any alternative approaches you've considered.
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -0,0 +1,29 @@
+name: .NET Build
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.0.x
+
+      - name: Restore dependencies
+        run: dotnet restore
+
+      - name: Build
+        run: dotnet build --no-restore --configuration Release
+
+      - name: Test
+        run: dotnet test --no-build --configuration Release --verbosity normal
+        continue-on-error: true
diff --git a/.gitignore b/.gitignore
@@ -277,3 +277,10 @@ __pycache__/
 # Custom
 **/aws-logger-errors.txt
 NuGet.Config
+
+# Environment and local settings
+.env
+.env.*
+!.env.example
+settings.local.json
+**/settings.local.json
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Contributing to Nwpie.Foundation.NetCore.SDK
+
+Thank you for your interest in contributing! Here's how to get started.
+
+## Development Setup
+
+```bash
+git clone https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK.git
+cd Nwpie.Foundation.NetCore.SDK
+dotnet restore
+dotnet build
+dotnet test
+```
+
+**Prerequisites**: .NET 8 SDK
+
+## How to Contribute
+
+1. **Fork** the repository
+2. **Create a branch**: `git checkout -b feature/my-feature`
+3. **Make your changes** and add tests where applicable
+4. **Run tests**: `dotnet test`
+5. **Submit a pull request** with a clear description of your changes
+
+## Project Structure
+
+```
+src/            # SDK modules (each module is self-contained)
+tests/          # Unit and integration tests
+samples/        # Sample applications (MiniSite, Serverless)
+docker/         # Docker configurations
+build/          # Build scripts and configurations
+```
+
+## Coding Guidelines
+
+- **Library projects** target `netstandard2.1` for broad compatibility
+- **Application projects** (endpoints, lambdas) target `net8.0`
+- Follow existing naming conventions and code style
+- Add unit tests for new functionality
+- Keep modules self-contained and loosely coupled
+
+## Reporting Issues
+
+- Use the [Bug Report](.github/ISSUE_TEMPLATE/bug_report.md) template for bugs
+- Use the [Feature Request](.github/ISSUE_TEMPLATE/feature_request.md) template for new ideas
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [BSD-3-Clause License](LICENSE).
diff --git a/README.md b/README.md
@@ -1,13 +1,18 @@
-﻿# Nwpie.Foundation.NetCore.SDK
+# Nwpie.Foundation.NetCore.SDK
 
 [![.NET](https://img.shields.io/badge/.NET-8.0-blue.svg)](https://dotnet.microsoft.com/download/dotnet/8.0)
 [![License](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](LICENSE)
+[![Build](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/actions/workflows/dotnet.yml/badge.svg)](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/actions/workflows/dotnet.yml)
+[![GitHub stars](https://img.shields.io/github/stars/osisdie/Nwpie.Foundation.NetCore.SDK)](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/stargazers)
+[![GitHub issues](https://img.shields.io/github/issues/osisdie/Nwpie.Foundation.NetCore.SDK)](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/issues)
+[![Last commit](https://img.shields.io/github/last-commit/osisdie/Nwpie.Foundation.NetCore.SDK)](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/commits/main)
 
 **Nwpie.Foundation.NetCore.SDK** is a comprehensive, modular SDK built for .NET Core (.NET 8) developers. It simplifies and enhances application development by providing an all-in-one solution with well-defined abstractions, robust utilities, and modularized components. This SDK is tailored for modern .NET Core projects and is fully supported with unit tests.
 
 ## Table of Contents
 - [Features](#features)
 - [Modules Overview](#modules-overview)
+- [Quick Start](#quick-start)
 - [Getting Started](#getting-started)
   - [Clone the Repository](#clone-the-repository)
   - [Explore Modules](#explore-modules)
@@ -49,6 +54,49 @@ The SDK provides the following modules, located under the `src/` directory:
 
 ---
 
+## Quick Start
+
+### Caching
+
+Register local or Redis caching in your DI container:
+
+```csharp
+// In-memory cache
+services.AddLocalCache<ILocalCache>();
+services.AddAsDefaultICache<ILocalCache>();
+
+// Redis cache (requires Caching.Redis module)
+services.AddRedisCache<IRedisCache>();
+```
+
+### Serialization
+
+Register the default JSON serializer:
+
+```csharp
+services.AddDefaultSerializer<ISerializer>();
+```
+
+### Service Startup
+
+A typical service `Startup.cs` wires up serialization, caching, and module-specific services:
+
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+    services.AddDefaultSerializer<ISerializer>();
+    services.AddLocalCache<ILocalCache>();
+    services.AddAsDefaultICache<ILocalCache>();
+
+    // Add module-specific services
+    services.AddConfigServer<IConfigServer>();
+}
+```
+
+See the [samples/](samples/) directory for complete working examples (MiniSite, Serverless).
+
+---
+
 ## Getting Started
 
 ### Clone the Repository
@@ -85,11 +133,7 @@ This will execute all unit tests and verify the SDK's functionality.
 ---
 
 ## Contributing
-We welcome contributions from the open-source community! To get involved:
-
-1. Fork the repository.
-2. Create a feature branch.
-3. Submit a pull request with detailed information about your changes.
+We welcome contributions from the open-source community! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
 
 ---
 
@@ -99,14 +143,4 @@ This project is licensed under the BSD-3-Clause License. See the [LICENSE](LICEN
 ---
 
 ## Support
-If you encounter any issues or have suggestions, feel free to open an issue on GitHub. We'd love to hear your feedback!
-
----
-
-Feel free to adapt this template as needed for your project's specifics!
-
----
-
-Happy coding! 🚀
-
----
+If you encounter any issues or have suggestions, feel free to open an [issue](https://github.com/osisdie/Nwpie.Foundation.NetCore.SDK/issues) on GitHub.
