Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/saintzet/dayzmapsloader

Project is to allow users to download maps for the game DayZ from two different map providers: Ginfo and Xam. The downloaded maps are of high quality and can be used to create different stuff. Also personal library of knowledge.
https://github.com/saintzet/dayzmapsloader

api asp-net-core clean-architecture clean-code cqrs-pattern dayz dayz-map ddd-architecture education entity-framework mssql-database react react-query repository-pattern swagger typescript webp

Last synced: about 1 month ago
JSON representation

Project is to allow users to download maps for the game DayZ from two different map providers: Ginfo and Xam. The downloaded maps are of high quality and can be used to create different stuff. Also personal library of knowledge.

Awesome Lists containing this project

README 

        





  

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]

[![LinkedIn][linkedin-shield]][linkedin-url]

  









  

    Logo

  



  


    Select your map, and create good stuff!    

    


    Explore the docs »

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  





  Table of Contents

  
    

        
  1. 

          About The Project

          

        
    2. 

        
  2. 

          Getting Started

          

        
    3. 

        
  3. Usage
    4. 

        
  4. Roadmap
    5. 

        
  5. Contributing
    6. 

        
  6. License
    7. 

        
  7. Contacts
    8. 

        
  8. Acknowledgments
    9. 

      



## About The Project



This Github pet project is an application built with Domain-Driven Design (DDD) architecture and modern development patterns. It has a server component built using ASP.NET Core and a client component built using React. 



The main purpose of this project is to allow users to download maps for the game DayZ from two different map providers: Ginfo and Xam. The downloaded maps are of high quality and can be used to create posters, cups, or other stuff. 



This repository is also a small personal library of knowledge.



(back to top)



### Built With

* [![.NET 6][.Net]][.Net-url]

* [![MicrosoftSQLServer][MicrosoftSQLServer]][MicrosoftSQLServer-url]

* [![Swagger][Swagger]][Swagger-url]

* [![React][React.js]][React-url]

* [![ReactQuery][ReactQuery]][ReactQuery-url]

* [![TypeScript][TypeScript]][TypeScript-url]



(back to top)



### Architecture

The concept of a Clean Architecture pattern has been around for over a decade and was initially conceived by Robert Martin. The keyword from Uncle Bob is Interchangeable. In the image below, everything on the blue circle is **interchangeable**, e.g., the UI can be swapped out from React to Angular, or the database can be migrated from MSSQL to Oracle, and nothing in the underlying layers needs to change.



The concept of having all your interfaces (Infrastructure and Application) in one project, will make it easier to Unit Test and mock.





  

    ddd-diagram

  




(back to top)



### Solution Structure






  Domain layer

      I used Anemic Domain Model. Is used in DDD when the main focus is on data persistence and 

      because in this project there's not much need for complex business logic.


      A Rich Domain Model is preferred when complex business logic needs to be encapsulated within the entities.


    


    


      

        domain-layer

      

    



 Application layer




  Public components

  


  
  •  Contracts - interfaces for the Infrastructure layer (pattern Repository) and Services.
    • 

      
  •  Features - Queries and Commands for pattern CQRS.
    • 

      
  •  Extensions - here we have a method for configuring this layer for DI container.
    • 

      
  •  Models - data necessary for internal work.
    • 

      
    

      Internal components

      
    

      
  •  Builders - classes that implement pattern builder.
    • 

      
  •  Services - CQRS Handlers use it to get results.
    • 

      
  •  Helpers - bad practice, but these classes made code more readable by grouping related functions and providing a clear purpose for the code.
    • 

      
    

      
    

        

          application-layer

            

      
    


     Infrastructure layer


    

      Public components

      
    

      
  •  Contexts - database contexts (EntityFramework).
    • 

      
  •  Migrations - database migrations (EntityFramework).
    • 

      
  •  Repositories - implement pattern Repository. 
    • 

      
  •  Extensions - here we have a method for configuring this layer for DI container.
    • 

      
  •  Services - infrastructure services (i/o operation, network e.g.).
    • 

      
    

      
    

        

          infrastructure-layer

            

      
    


     Presentation layer

      

    #### Web Api
    


      Public components

      
    

      
  •  wwwroot - have custom UI for Swagger.
    • 

      
  •  Controllers - connection between Application and Client(web, desktop, mobile).
    • 

      
    

      Internal components

      
    

      
  •  Extensions - here we have the method for configuring DI container.
    • 

      
    

      
    

        

          presentation-web-api

            

      
    


    #### Wpf
    


    Built using pattern MVVM pattern with modern approaches.


    

    

        

          presentation-wpf

            

    


     Unit/integrations test


    

      The tests covered the main elements of the system. Secondary elements such as migrations are not covered, there is no coverage of the project's WPF.

      
    

      
    

      
    

        

          tests-xunit

            

      
    


      
    

        

          test-covarage

            

      
    


    (back to top)
    


    ## Getting Started
    


    This is an example of how you may give instructions on setting up your project locally.

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


    ### Prerequisites
    


    This is an example of how to list things you need to use the software and how to install them.

    * npm

      ```sh

      npm install npm@latest -g

      ```

     * Dotnet ef

         ```sh

         dotnet tool install dotnet-ef -g

         ```
    


    ### Installation
    


    1. Clone the repo

       ```sh

       git clone https://github.com/SaintZet/DayzMapsLoader.git

       ```

    2. Install NPM packages

       ```sh

       npm install

       ```

    3. Add a appsettings.json with connection string to DayzMapsLoader.Presentation.WebApi 

       ```json

         "ConnectionStrings": {

        "DefaultConnection": "Server = YourServer; DataBase=DayzMapLoader; User id= YourUserID; password= YourPassword; Integrated Security=True; TrustServerCertificate=True;"

        }

       ```

     4. At this point you can have EF create database and create schema from the migration .NET CLI:

         ```sh

         dotnet ef database update --startup-project ../DayzMapsLoader.Presentation.WebApi --project ../DayzMapsLoader.Infrastructure

         ```
    


    (back to top)
    


    ## Usage
    


    At the moment you can install the latest version of the product to start the server and get all the necessary maps. 

    You know what to do with them.
    


    You can create a fork and expand the repository, for example 

    * create a desktop client 

    * change image processing algorithms

    * add functionality that is useful to you

    * other
    


    Take some techniques and approaches to your projects.
    


    And of course - to contribute to the development of the project, help with existing issues or create a new one, improve the algorithm, or change something else!
    


    (back to top)
    


    ## Roadmap
    


    - [x] Provide archive(web) and byte array(desktop) with

        - [x] selected map

        - [x] selected map in parts

        - [x] all maps by specific provider

    - [ ] Options for select a map

        - [x] provider (GInfo e.g.)

        - [x] name (Chernarus e.g)

        - [ ] type

            - [x] satellite

            - [x] topographic

            - [ ] tourist

        - [x] zoom level

        - [ ] version

        - [ ] image quality

        - [ ] image extension

     - [x] Desctop client on WPF

     - [ ] Web client on React (in the process)

     - [ ] Hosting server and client

     - [ ] Improve performance - store images on the server and just download them when changed something (e.g version map).
    


    See the [open issues](https://github.com/SaintZet/DayzMapsLoader/issues) for a full list of proposed features (and known issues).
    


    (back to top)
    


    ## Contributing
    


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


    If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

    Don't forget to give the project a star! Thanks again!
    


    1. Fork the Project

    2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

    3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

    4. Push to the Branch (`git push origin feature/AmazingFeature`)

    5. Open a Pull Request
    


    (back to top)
    


    ## License
    


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


    (back to top)
    


    ## Contacts
    


    Chepets Serhii - [@LinkedIn](https://www.linkedin.com/in/serhii-chepets/) - [email protected]
    


    Yaroslav Tymchenko -[@LinkedIn](https://www.linkedin.com/in/yaroslavtymchenko/) - [email protected]
    


    (back to top)
    


    ## Acknowledgments
    


    Domain Driven Design


    

      

       
    • https://www.codeproject.com/Articles/5351235/Clean-Architecture-Incorporating-Repository-Patter
      • 

       
    • https://dev.to/stevescruz/domain-driven-design-ddd-file-structure-4pja
      • 

       
    • https://thedomaindrivendesign.io/anemic-model-x-rich-model/
      • 

       
    • https://medium.com/software-alchemy/a-brief-intro-to-clean-architecture-clean-ddd-and-cqrs-23243c3f31b3
      • 

       
    • https://medium.com/software-alchemy/a-template-for-clean-domain-driven-design-architecture-e386ad235f32
      • 

    


    Unit Of Work and Repository patterns


    

      

       
    • https://www.programmingwithwolfgang.com/repository-pattern-net-core/
      • 

       
    • https://dotnettutorials.net/lesson/repository-design-pattern-csharp/
      • 

       
    • https://exceptionnotfound.net/the-repository-service-pattern-with-dependency-injection-and-asp-net-core/
      • 

       
    • https://mentormate.com/blog/service-and-repository-layer-interaction-in-c/
      • 

       
    • https://gunnarpeipman.com/ef-core-repository-unit-of-work/
      • 

    


    Cqrs and MediatR patterns


    

      

        
    • https://codeopinion.com/should-you-use-the-repository-pattern-with-cqrs-yes-and-no/
      • 

        
    • https://abdelmajid-baco.medium.com/cqrs-pattern-with-c-a9aff05aae3f
      • 

        
    • https://code-maze.com/cqrs-mediatr-in-aspnet-core/
      • 

        
    • https://www.puresourcecode.com/dotnet/introducing-cqrs-in-the-architecture/
      • 

        
    • https://medium.com/@dbottiau/a-naive-introduction-to-cqrs-in-c-9d0d99cd2d54
      • 

        
    • https://learn.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/microservice-application-layer-implementation-web-api
      • 

        
    • https://learn.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/cqrs-microservice-reads
      • 

    


    Swagger


    

      

        
    • https://github.com/ostranme/swagger-ui-themes
      • 

        
    • https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-7.0&tabs=visual-studio
      • 

    


    (back to top)
    


    [contributors-shield]: https://img.shields.io/github/contributors/SaintZet/DayzMapsLoader.svg?style=for-the-badge

    [contributors-url]: https://github.com/SaintZet/DayzMapsLoader/graphs/contributors

    [forks-shield]: https://img.shields.io/github/forks/SaintZet/DayzMapsLoader.svg?style=for-the-badge

    [forks-url]: https://github.com/SaintZet/DayzMapsLoader/network/members

    [stars-shield]: https://img.shields.io/github/stars/SaintZet/DayzMapsLoader.svg?style=for-the-badge

    [stars-url]: https://github.com/SaintZet/DayzMapsLoader/stargazers

    [issues-shield]: https://img.shields.io/github/issues/SaintZet/DayzMapsLoader.svg?style=for-the-badge

    [issues-url]: https://github.com/SaintZet/DayzMapsLoader/issues

    [license-shield]: https://img.shields.io/github/license/SaintZet/DayzMapsLoader.svg?style=for-the-badge

    [license-url]: https://github.com/SaintZet/DayzMapsLoader/blob/master/LICENSE.txt

    [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

    [linkedin-url]: https://www.linkedin.com/in/serhii-chepets/
    


    [product-screenshot]: images/banner.png
    


    [.Net]: https://img.shields.io/badge/.NET-5C2D91?style=for-the-badge&logo=.net&logoColor=white

    [.Net-url]: https://dotnet.microsoft.com/en-us/

    [Swagger]: https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white

    [Swagger-url]: https://swagger.io

    [MicrosoftSQLServer]: https://img.shields.io/badge/Microsoft%20SQL%20Server-CC2927?style=for-the-badge&logo=microsoft%20sql%20server&logoColor=white

    [MicrosoftSQLServer-url]: https://www.microsoft.com/en-us/sql-server/sql-server-downloads

    [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB

    [React-url]: https://reactjs.org/

    [ReactQuery]: https://img.shields.io/badge/-React%20Query-FF4154?style=for-the-badge&logo=react%20query&logoColor=white

    [ReactQuery-url]: https://react-query-v3.tanstack.com

    [TypeScript]: https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white

    [TypeScript-url]: https://www.typescriptlang.org