Skip to content

project folder structure #55

Closed
Closed

Description

@kevinsshikuku

Description

I would like to suggest a folder structure that is easy to comprehend and hierarchical.

Solution description

Project files should be placed in categorized folders based on what they do.

Additional information

No response

Activity

  1. lekipising commented on Jun 16, 2022

    @lekipising
    Contributor

    I agree with this.

    I would like to propose the following structure.

    components - This folder will contain all the components used in the project. We can also group components inside of this folder by the related sections.

    pages - Default and provided by Next JS

    public - Default and provided by Next JS

    styles - This folder will be used to hold any global custom styles for the project

    util - This folder will be used to hold any helper functions, methods, utilities, etc that support the project.

    mock - This folder will be used to hold any mock data we will need to use in the project. E.g hold sample data for the UI before any API is ready to provide data.

    tests - This folder will have folders containing different types of tests. Eg a folder for e2e tests, unit tests and integration tests.

    Anyone is welcome to comment, give feedback and suggest improvements and/or provide alternatives.

  2. lekipising commented on Jun 17, 2022

    @lekipising
    Contributor

    The structure looks good.

  3. kevinsshikuku commented on Jun 17, 2022

    @kevinsshikuku
    Author

    Screenshot from 2022-06-17 01-39-59

    external styling should be minimal (suggestion) as we already have a library . Tailwind can do most

    This seems reasonable, we can adopt this

  4. locked and limited conversation to collaborators on Jun 17, 2022
  5. converted this issue into a discussion #61 on Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions