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

Restructure and Refactor the file structure and code #60

Open
mbcse opened this issue Feb 27, 2024 · 5 comments
Open

Restructure and Refactor the file structure and code #60

mbcse opened this issue Feb 27, 2024 · 5 comments
Labels

Comments

@mbcse
Copy link
Collaborator

mbcse commented Feb 27, 2024

Description

As our project advances towards the integration of additional chains and functionalities, it becomes imperative to enhance the organization of our codebase for improved maintainability and clarity. The proposed solution involves a thorough refactor of the current folder structure, specifically segregating functionalities into distinct folders.

Objective

To establish a more organized and scalable folder structure that accommodates the growing complexity of integrating various chains and functions seamlessly.

Proposed Changes

Introduce a refined folder structure that categorizes functionalities based on their respective chains. Specifically, create separate folders for each chain, where the related contracts and associated functions will reside.

Example

project-root/
|-- chain1/
|   |-- contracts/
|   |-- functions/
|-- chain2/
|   |-- contracts/
|   |-- functions/
|-- shared/
|   |-- common/
|   |-- utilities/
|-- other_folders_and_files...
@mbcse mbcse added enhancement New feature or request Good First Issue(GSoC) labels Feb 27, 2024
@AnmolSirola
Copy link

@mbcse I am participating in this year's GSoC and would like to contribute to the NFT-Toolbox project. May I take on this issue?

@mbcse
Copy link
Collaborator Author

mbcse commented Feb 27, 2024

Hey @AnmolSirola Yes Sure, Just work on the issue, No need to ask for approval:)

@AnmolSirola
Copy link

@mbcse I have come across two ways of refactoring the file structure.

Current state:
Current

Note: I have used only Ethereum, Solana and Tezos for example. The same format will be used for Aptos and Flow.

refined structure 1:
1

refined structure 2:
2

Can you tell me which one of them would be better and suggest any changes. I will make a pr according to it :)

@mbcse
Copy link
Collaborator Author

mbcse commented Mar 4, 2024

Hey @AnmolSirola I think Structure 2 will be good.
Also Please move discussions to this repo now https://github.com/c2siorg/NFT-Toolbox.

@AnmolSirola
Copy link

@mbcse Sure :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants