refactor(caesar): restructure the project to a monorepo #93

Merged
PatrykHegenberg merged 1 commit from 72-restructure-the-project-to-a-monorepo into main 2024-05-05 13:55:00 +02:00
PatrykHegenberg commented 2024-05-05 13:49:55 +02:00 (Migrated from github.com)

Description

I have restructured the repository to make it a monorepo. The CLI app parts and the parts for shuttle.rs were each moved to their own sub-crate. The core components of the application were merged into a library crate that is used by the other parts. This was done to make it easier to develop a GUI component later on.

Motivation and Context

The motivation for these changes is to restructure the repository into a monorepo to facilitate the development of a GUI component further down the line. By merging the core components of the application into a library crate and splitting the CLI app parts as well as the parts for shuttle.rs into separate sub-crates, a clearer and better organized code base is created. These changes help to improve the maintainability and extensibility of the project by enabling a clearer separation of responsibilities between different parts of the application.

How Has This Been Tested?

I performed manual tests with a local relay and against the shuttle RS-Relay. I used cargo check and cargo clippy to check whether improvements were possible and used cargo test to run all existing tests.

Screenshots / Logs (if applicable)

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
## Description I have restructured the repository to make it a monorepo. The CLI app parts and the parts for shuttle.rs were each moved to their own sub-crate. The core components of the application were merged into a library crate that is used by the other parts. This was done to make it easier to develop a GUI component later on. ## Motivation and Context The motivation for these changes is to restructure the repository into a monorepo to facilitate the development of a GUI component further down the line. By merging the core components of the application into a library crate and splitting the CLI app parts as well as the parts for shuttle.rs into separate sub-crates, a clearer and better organized code base is created. These changes help to improve the maintainability and extensibility of the project by enabling a clearer separation of responsibilities between different parts of the application. ## How Has This Been Tested? I performed manual tests with a local relay and against the shuttle RS-Relay. I used cargo check and cargo clippy to check whether improvements were possible and used cargo test to run all existing tests. ## Screenshots / Logs (if applicable) ## Types of Changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation (no code change) - [x] Refactor (refactoring production code) - [ ] Other <!--- (provide information) --> ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] My code follows the code style of this project. - [ ] I have updated the documentation accordingly. - [x] I have formatted the code with [rustfmt](https://github.com/rust-lang/rustfmt). - [x] I checked the lints with [clippy](https://github.com/rust-lang/rust-clippy). - [ ] I have added tests to cover my changes. - [x] All new and existing tests passed. <!--- Thank you for contributing! -->
Sign in to join this conversation.
No description provided.