React Opinionated Folder Structure

An opinionated folder structure for React projects.

The motivation is to create a folder structure that you can start with and focus on the features to build instead of folder conventions.

This is based on React's create-react-app.

Getting started

Run:

git clone https://github.com/yasuf/react-opinionated-folder-structure
cd react-opinionated-folder-structure
npm install
npm start

After this look around, see the folders and copy over what you need into your project or just start editing this project and turning it into your app.

Folder descriptions

src/components/

All the React components for the App.

src/components/<MyComponent>/

All files related to a single component.

Files for a component:

src/components/<MyComponent>/index.test.tsx - Test file

src/components/<MyComponent>/index.tsx - Component file

src/components/<MyComponent>/styles.css - Styles file

src/hooks/

All React hooks.

src/request/

All HTTP request files.

src/assets/

All assets (.svg, .png, .gif files).

Design choices

Typescript: Comes with Typescript already setup, it's recommended you use Typescript with React.

Unit Tests: Has tests for components using Testing Library, follow its guidelines and write unit tests for your components.

Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.