Skip to content
New issue

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

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

Already on GitHub? # to your account

Project structure #20

Merged
merged 7 commits into from
Mar 26, 2024
Merged

Project structure #20

merged 7 commits into from
Mar 26, 2024

Conversation

Aidasvenc
Copy link
Collaborator

Global project structure has now been defined. Let's go through it:

  • screens folder will contain all screens in the app. It is furthermore divided into flows: Onboarding , Registration, Profile etc. Each such folder can contain one or multiple screens, e.g. Registration has multiple screens: AuthenticationScreen, InterestsScreen, InformationScreen. Each screen has its' own folder with two files: ___Screen.tsx and styles.ts. One will contain the component itself and one will contain the style sheet for that screen. It is done for convenience, since style sheets can get extensively large. Feel free to add flows and screens based on our Figma mockup, but make sure to follow the conventions.
  • components folder consists of re-usable components that can be re-used in more than one screen, e.g. InputField (that will be re-used in the registration flow), LargeButton (a large wide button to proceed), SmallButton (you can already see many such small buttons in the Figma mockup). Each such component has its' own folder with two files - the same idea as with screens.
  • navigation folder will contain all navigation related items: navigation containers, stacks and tab navigators. This is where @alexandre-mrt will Set up React Navigation #9
  • assets folder contains images and colors. We defined a global file there to store the color definitions to not have to re-define colors each time, e.g. peach color that represents uniconnect branding stands for #FD9890.

All in all, this will help us to structure the project files in a unified manner and will ultimately help us easily navigate over many files that will be created in the future. Please add your remarks and suggestions for further project structure improvement.

@Aidasvenc
Copy link
Collaborator Author

Additional code style and formatting rules are needed:

  • no semicolons
  • enforced indenting of 2 spaces

Copy link
Collaborator

@Fyuryy Fyuryy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job!

Copy link

@GustaveCharles
Copy link
Collaborator

LGTM

@Fyuryy Fyuryy merged commit bbc8473 into main Mar 26, 2024
3 checks passed
Copy link
Collaborator

@GustaveCharles GustaveCharles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@GustaveCharles GustaveCharles deleted the project-structure branch April 4, 2024 08:43
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants