Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Integration of Ginkgo Testing Framework and Refactoring Backend Folder Structure #26

Open
yashpandey06 opened this issue Jan 23, 2025 · 4 comments
Labels
enhancement New feature or request

Comments

@yashpandey06
Copy link
Contributor

Problem Statement

Currently, the backend codebase lacks a clear structure, with all logic contained in a single main.go file. This makes the code harder to read, maintain, and scale. Additionally, there is no testing framework integrated for backend testing, which is essential to ensure the stability and reliability of the code.

Proposed Solution

  1. Refactor the Folder Directory Structure:

    • Restructure the backend codebase to follow a modular and organized structure.
    • Separate concerns into different directories, such as routes/, handlers/, services/, models/, etc.
    • Improve readability and maintainability by adhering to industry best practices.
  2. Integrate Ginkgo for Testing:

    • Use Ginkgo, a behavior-driven testing framework for Go, to write descriptive and structured test cases for backend components.
    • Configure Ginkgo in the project with example test cases to demonstrate its usage.

These changes will enhance the maintainability and scalability of the codebase while encouraging proper testing practices.

Additional Context or Mockups

A sample folder structure for the backend after refactoring could look like this:

@yashpandey06 yashpandey06 added the enhancement New feature or request label Jan 23, 2025
@Gmin2
Copy link
Contributor

Gmin2 commented Jan 23, 2025

tbh its of no use for now, first let us implement some functionality

@yashpandey06
Copy link
Contributor Author

@Gmin2 who claims to solve it right now ? ...issues are meant to be solved async

@anj20
Copy link

anj20 commented Jan 23, 2025

hi @yashpandey06 , i am interested in refactoring and writing unit test for go backend and would like to work on this issue.

@clubanderson
Copy link
Contributor

@yashpandey06 can you work with @anj20 to see if they can help?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

4 participants