im newbie in react and im having a hard time trying to organise my project structure. Right now im puting everything into my components folder but since its large website that im creating, it can become very confusing to navigate. What is the best practice to organise components? Lets say i have 2 subpages homepage and about us. In each of them i have 2 containers (sections) with 2 components each. So it would look smth like that:
Homepage - > Section A [component A, component B] | Section B [component C, component A]
AboutUs -> Section New [component X, component Y] | Section Old [component Z, component A]
How would u create your folders for something like that?
Im putting everything into components folder so its look like long list:
-Hompage
-AboutUs
-Sections A
-Component A
... and so on.
It can be frustrating when you are just starting out trying to find a good folder structure and having everyone tell you to just do what works best for you. You may not have enough experience to know what works best for you!
There are 2 main ways I have organized my projects and it has always depended on what my team has preferred.
The first way is not my personal favorite:
Option1: Single Folder for Component + Test, notice we keep the very simple layout components in their own grouped folder. Sometimes there can also be a 'shared' folder for widely used components.
src/
├─ components/
│ ├─ layout/
│ │ ├─ header.jsx
│ │ ├─ footer.jsx
│ │ ├─ page.jsx/
| | |
│ ├─ hero-dispay/
│ │ ├─ HeroDisplay.jsx
│ │ ├─ HeroDisplay.test.jsx
│ ├─ login-form/
│ │ ├─ LoginForm.jsx
│ │ ├─ LoginForm.test.jsx
│ ├─ home-page/
│ │ ├─ HomePage.jsx
│ ├─ landing-page/
│ │ ├─ LandingPage.jsx
├─ App.jsx
Option 2: Separation of Concerns Here, we organize our components by where in the app they go. This works best for highly paginated apps. If I notice that I use something between two 'page' components, then I graduate it to its own folder in the 'components' folder. Again, I have a shared folder for very simple reusued components. Don't be afraid to use sub-folders under the parent folders.
src/
├─ components/
│ ├─ layout/
│ │ ├─ header.jsx
│ │ ├─ footer.jsx
│ │ ├─ page.jsx/
│ ├─ home-page/
│ │ ├─ HeroDisplay.tsx
│ │ ├─ HeroDisplay.test.tsx
│ │ ├─ HomePage.tsx
│ ├─ landing-page/
│ │ ├─ LoginForm.tsx
│ │ ├─ LoginForm.test.tx
│ │ ├─ LandingPage.jsx
│ ├─ shared/
│ │ ├─ Avatar.tsx
│ │ ├─ NotificationBar.tsx
├─ App.jsx
I will attach a picture of a recent small project I did that was a web-app for filtering job applications. Of course there will be people that disagree with my methods (and If I were to restart the app I may organize things differently). The important part is to not spend too long thinking about it. Just pick a pattern, and stick with it for the project. You will learn what you do and don't like as you go and can re try when you start a fresh project!
Best of Luck!
There are multiple ways of organizing your code, you can for example divide it by sections as you already described, and have a shared folder where component A can be located as it is being used on multiple sections.
At the end of the day, the best folder structure is the one that you can understand, feel comfortable with, and can easily explain.
Personal advice, create a brief readme that explains your approach. That way when you work with somebody else, they will get a glance at where things are.
Related
I just started using Remix.run and I'm trying to add a ssl certificate to my site and it requires that I make this specific path available in my app that's similar to this
www.mypage.com/.well-known/pki-validation/blah.txt
Unfortunately, I find that when i create a route folder in Remix that starts with a dot, it returns a 404 response. Even when i try to escape it in the name like so [.]well-known
https://remix.run/docs/en/v1/guides/resource-routes#url-escaping
Example of what I've tried.
app/
├── routes/
│ ├── [.]well-known/
│ │ ├── pki-validation
│ │ ├────── blah[.]txt.tsx
│ └── about.tsx
│ └── index.tsx
└── root.tsx
Any ideas? Thanks.
I think you are supposed to wrap more between those brackets.
app/
├── routes/
│ ├── [.well-known]/
│ │ ├── pki-validation
│ │ ├────── [blah.txt].tsx
│ └── about.tsx
│ └── index.tsx
└── root.tsx
Think i got something working here: https://stackblitz.com/edit/node-wmuju8
Edit: seems like escaping the dot in the wellknown folder and file is enough, so not sure why it is not working for you.
The question is - how to force Jest to follow symlinked shared folder file structure but not main shared folder?
I have the next files structure:
root
├── projects
│ ├── A
│ │ ├── node_modules
│ │ ├── shared (symlink ../../shared-main)
│ │ ├── components
│ │ ├── settings.ts
│ ├── B
│ │ ├── node_modules
│ │ ├── shared (symlink ../../shared-main)
│ │ ├── components
│ │ ├── settings.ts
├── shared-main
│ ├── utils.ts
│ ├── config.ts
In my projects, A and B, I use utils from the shared folder. Utils.ts uses config.ts where imports settings files by path './settings.ts', but inside the shared-main folder, it looks like "file doesn't exist" (it is ok). But Jest in a project's tests when it meets using a shared file test fails with the error: "../../shared-main/config.ts:9:35 - error TS2307: Cannot find module '../settings' or its corresponding type declarations."
How to get around this and force Jest to use config.ts from the symlink folder instead of the main one?
How about "testRegex": ["test/.*.[jt]s"], in your jest config so it doesn't try and find shared files, if you're using shared files across multiple projects then no single project should test those files, they should only test their own files.
However I'm not so sure that symlinks are your problem, when using typescript like this and trying to use files outside of your project rootDir it will not find the types for it or it will complain that it can't find the types for it if you've added it to tsconfig include/exclude. Right now I can only assume that you're using tsc --project with specific config files for each project.
// tsconfig.json
"include": ["projectA/**/*.ts"],
If you've done something like that then it won't find any types outside of projectA so anything in config.ts and utils.ts will not have any types or be able to find any modules, unless they're included in your tsconfig.
To show a simpler example if I have:
// tsconfig.json
...
includes: ["src/**/*.ts"]
...
Along with a directory structure like this:
- tsconfig.json
- example.ts
- src
Then anything in example.ts will not be able to find its types or module imports.
The way I get around this issue in my project is to use ts-jest along with specifying where to find tests, along with overriding the globals rootDir.
// .jestrc.json
"testRegex": ["test/.*.[jt]s"],
...
"globals": {
"ts-jest": {
"tsconfig": {
"rootDir": "."
}
}
}
we are creating a new react project using create-react-apps and we are trying to figure out a way to organise our page components. After some discussion, we basically have come up with 2 solutions
the first solution is to use hierarchical structure as shown below
src/
├── copmonents/
│ ├── sharedComponent1
│ ├── sharedComponent2
│ ├── sharedComponent3
| └── sharedComponent4
├── pages/
│ ├── page1/
│ | ├── component1/
│ | | ├── component11/
│ | | | ├── component111
│ | | | └── component112
│ | | └── component12
│ | └── component12
│ ├── page2 (same as above)
│ └── page3 (same as above)
└── utils/
We create pages and put components inside them. Once we find a component is used in multiple places, we hoist it into the component folder.
Idea behind is to use file hierarchy to reflect component structure. We fell developers might find it easier to locate files using this solution, but drawback would be it can easily go too deep?
the second solution is to use a 'flat' structure
src/
├── copmonents/
│ ├── component1
│ ├── component2
│ ├── component3
│ ├── component4
│ ├── component5
│ ├── component6
│ ├── component7
│ ├── component8
│ ├── component9
| └── component10
├── pages/
│ ├── page1.tsx
│ ├── page2.tsx
| └── page3.tsx
└── utils/
this way we have a very lean page folder and keep all components into a components folder. While this structure seems to be cleaner than the first one, I do agree that some people may feel this solution "less organised" as all components are dumped into a centralised place.
I do recognise this is a highly opinionated topic and I was thinking of using json normaliser as an analogy, but people even have different opinions in normalizing json.
thoughts?
Move files around until it feels right ref
Dan Abramov’s site
But, you can aboard it strategically with features (layout, Button, basket)
src/
├── copmonents/
│ ├── Layout
│ ├── Basket
│ ├── Button
| └── Feature specific
├── pages/
│ ├── page1/
│ | ├── index.ts/js/
│ | ├── logic.tsx
│ | └── ui-specific-to-page
│ ├── page2 (same as above)
│
└ hooks
one point that I missed in my initial post(I only discovered it yesterday), with the hierarchical code structure, we will end up with long referrence paths like ../../../../utils inside your components (imagine you are referring to a utils function inside component111 or it's sub components). While with the flat structure we don't have this type of issues.
there are ways to get around with it, like a custom resolve for webpack, but it may involve some effort to set it up (especially when your project is bootstrapped by cra)
src/
├── copmonents/
│ ├── sharedComponent1
│ ├── sharedComponent2
│ ├── sharedComponent3
| └── sharedComponent4
├── pages/
│ ├── page1/
│ | ├── component1/
│ | | ├── component11/
│ | | | ├── component111
│ | | | └── component112
│ | | └── component12
│ | └── component12
│ ├── page2 (same as above)
│ └── page3 (same as above)
└── utils/
I am using Github Actions to run CI and CD for my NextJS app (v9.4.4).
I currently have a jsconfig.json file as the following:
{
"compilerOptions": {
"baseUrl": "src"
}
}
This is great as I can do import Nav from "components/Nav" in lieu of import Nav from "src/components/Nav" and is working perfectly locally (with either next dev or next build).
However, when I try to build the NextJS app on Github Actions, it errors with:
./src/App/index.jsx
Module not found: Can't resolve 'contexts/firebase' in '/home/runner/work/MyFirebaseApp/MyFirebaseApp/src/App'
For context, a sample of my file structure is:
MyFirebaseApp
│ .github
│ next.config.js
│ jsconfig.json
│ ...more config files...
│
└───src
│ │
│ └───App
│ │ │ index.jsx
│ │
│ └───components
│ │ Nav.jsx
│ │
│ └───contexts
│ │ firebase.jsx
I have tried changing the baseUrl to home/runner/work/MyFirebaseApp/MyFirebaseApp/src without any luck.
Is there special webpack configuration or changes I need to make for this to build on Github Actions?
i’ve juz started with angular, i saw this post on folder structuring http://www.johnpapa.net/angular-growth-structure/
This is what my folder looks like which i'm building for an eCommerce site frontend:
.
├── index.html
├── css
├── images
├── fonts
├── scripts
│ ├── app.js
│ ├── directives
│ │ ├── search
│ │ ├── image-slider
│ │ ├── faq
│ │ └── form
│ └── api
└── templates
├── nav.html
├── footer.html
└── page
├── full.html
└── sidebar-right.html
Is there any better way/practice that you would do for this?
My greatest worry would be moving on into integrations with a CMS(opencart/magento) folder structure.
Your dir structure looks fine, however you may run into issues while integrating with any CMS as they put their views on a different directory.
Workaround: Once you do integrate Magento or some random CMS, move your views to the CMS's view folder and make sure you serve index.html with your angular from the CMS.
Hope I could help.