📁 Folder System Overview
Organizing your Smart Dev resources using a structured file system is essential for maintaining clarity and efficiency in your Web3 projects. While it’s possible to place all resources at the root level, adopting a well-organized folder structure significantly enhances navigation speed and project scalability.
🗂️ Why Use Folders?
- 🔍 Easier Navigation: Quickly locate specific resources without sifting through a cluttered root directory.
- 📈 Scalability: Seamlessly manage and expand your project as it grows in complexity.
🛠️ Recommended Folder Structure
To get the most out of Smart Dev, we recommend organizing your project resources into the following folder structure:
Tip: Tailor the folder names to match the specific needs of your project for optimal organization.
📂 Suggested Structure
Below is an example of how your project directory should look using the recommended structure:
📂 Folder Descriptions
Note: [your_project_path] can be nested within multiple folders based on your project’s structure, example:
sub_project/sub_dir/*.
🔒 contracts/
Store all your smart contract files here.
🔑 wallets/
Doesn’t lose your wallets anymore! Keep them in this directory.
🌊 pools/
Organize your wallets pools in this directory. Keeping these resources together simplifies the management of your pools.
📚 resources/
Store any additional resources, such as documentation, images, or other files that are not directly related to contracts, wallets, or pools.
📈 Best Practices
- Consistent Naming: Use clear and consistent naming conventions for folders and files to avoid confusion (we recommend kebab-case).
- Modularization: Break down large folders into smaller subfolders to manage resources more effectively.
- Documentation: Include README or resources files within each folder to describe the purpose and usage of its contents.
By following this structured approach, you’ll ensure that your Smart Dev projects remain organized, scalable, and easy to navigate. Happy building! 🚀