Skip to content

kodlamaio-projects/nArchitecture.Gen

Repository files navigation


nArchitecture Project Code Generator Tool

Report Bug · Request Feature

💻 About The Project

As Kodlama.io, we have chosen to unveil examples of finalized projects. Natively integrated with Clean Architecture principles, nArchitecture CLI tool epitomizes cutting-edge development methodologies. This monolithic project incorporates Clean Architecture, CQRS, Advanced Repository patterns, Dynamic Querying capabilities, JWT and OTP authentication mechanisms, Google & Microsoft Auth integration, Role-Based Management systems, Distributed Caching powered by Redis, Logging functionalities leveraging Serilog, Elastic Search functionalities, and a feature-rich Code Generator. By actively contributing, you not only bolster the project but also acquire invaluable insights and expertise.

Built With

⚙️ Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • .NET 8

Installation

  1. Install the tool globally:

    dotnet tool install --global NArchitecture.Gen

    You can also install the tool locally in the project:

    1. Create dotnet tool manifest:
    dotnet new tool-manifest
    1. Install the tool locally:
    dotnet tool install NArchitecture.Gen

🚀 Usage

  1. Run nArchGen command in project solution directory.

🚧 Roadmap

See the open issues for a list of proposed features (and known issues).

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the project and clone your local machine

  2. Create your Feature Branch:

    git checkout -b <Feature>/<AmazingFeature>
  3. Develop

  4. Commit your Changes:

    git add . && git commit -m '<SemanticCommitType>(<Scope>): <AmazingFeature>'

    💡 Check Semantic Commit Messages.

    💡 You can also use Commitizen CLI.

  5. Push to the Branch:

    git push origin <Feature>/<AmazingFeature>
  6. Open a Pull Request

Analysis

  1. If not, Install dotnet tool dotnet tool restore.
  2. Run anaylsis command dotnet roslynator analyze

Format

  1. If not, Install dotnet tool dotnet tool restore.
  2. Run format command dotnet csharpier .

⚖️ License

Distributed under the MIT License. See LICENSE for more information.

📧 Contact

Project Link: https://github.com/kodlamaio-projects/nArchitecture.Gen