keizerworks / keizer-auth

API for keizer-auth
MIT License
10 stars 9 forks source link

[CHORE] 🔢 Create a Sample Endpoint for New Contributors to Understand Project Architecture #14

Closed Sudarsh1010 closed 3 weeks ago

Sudarsh1010 commented 3 weeks ago

Description

Objective: Set up a sample endpoint to demonstrate the architecture and folder structure, making it easier for new contributors to understand the project’s layout and conventions. The example should include a walkthrough of essential components, including containers, singletons, repositories, services, controllers, and database integrations.

Description: To help new contributors get acquainted with the project's architecture and design patterns, we want to create a simple yet complete sample endpoint. This endpoint should exemplify how components like dependency injection, repositories, services, and controllers interact with each other. It should follow our project’s best practices and clearly illustrate the use of:

Containers for managing dependencies
Singletons for shared instances across the application
Repositories for database interactions
Services for business logic
Controllers for request handling
Database integrations to demonstrate schema interactions

The sample should also showcase consistent naming conventions, such as using snake_case for input validation.

Anything else?

No response

Are you willing to submit PR?

Yes