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

#1 - Boilerplate Folder Structure #26

Closed
ThunderNaka opened this issue Jul 23, 2024 · 0 comments · Fixed by #33
Closed

#1 - Boilerplate Folder Structure #26

ThunderNaka opened this issue Jul 23, 2024 · 0 comments · Fixed by #33
Labels
enhancement New feature or request

Comments

@ThunderNaka
Copy link
Collaborator

ThunderNaka commented Jul 23, 2024

Folder Structure Proposal

This issue aims to establish a well-organized folder structure for our project. Below are the key areas we need to address:

Some tips for you:

Keep it simple. Avoid overly complex hierarchies and file structures. Deeply nested folders can make it difficult to find files and can become unwieldy.

Consistency. Establishing and adhering to a consistent naming convention part of core file and folder structure best practices. Be logical, grouping based on factors such as category or functionality.

Accessibility and sharing. Based on goals for sharing and collaborating on files, ensure the computer file structure organization allows for ease of use among team members.

Top-Level Structure

  • Define the primary directories and their purposes.

Categorization

  • Determine how to categorize different types of files and components.

Components

  • Structure: Outline how components, their tests, styles, hooks, and subcomponents should be organized.
  • Regular vs Reusable: Specify the colocation of regular components and reusable components.

Hooks

  • Define the colocation and structure for hooks.

Constants

  • Establish where constants should be located.

Data Layer

  • Outline the structure for everything related to API calls.

Utils

  • Define the colocation for utility functions.

Styles

  • Determine if there should be a dedicated styles directory and its structure.

Pages/Screens

  • Colocation: Define where pages/screens should be located.
  • Naming: Establish naming conventions for pages/screens.
  • Structure: Specify how a screen should be organized.
@ThunderNaka ThunderNaka changed the title Boilerplate Folder Structure #1 - Boilerplate Folder Structure Jul 23, 2024
@ThunderNaka ThunderNaka added the enhancement New feature or request label Jul 23, 2024
@ThunderNaka ThunderNaka linked a pull request Sep 22, 2024 that will close this issue
8 tasks
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
None yet
Development

Successfully merging a pull request may close this issue.

1 participant