Skip to content

Project Structure

Vikram Sardiwal edited this page Aug 5, 2026 · 1 revision

Project Structure

The project follows a simple React structure to make development and contribution easier.

react-open-source/
β”‚
β”œβ”€β”€ public/
β”‚
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ assets/
β”‚   β”œβ”€β”€ components/
β”‚   β”œβ”€β”€ pages/
β”‚   β”œβ”€β”€ App.jsx
β”‚   β”œβ”€β”€ main.jsx
β”‚   └── ...
β”‚
β”œβ”€β”€ .github/
β”‚   β”œβ”€β”€ ISSUE_TEMPLATE/
β”‚   └── PULL_REQUEST_TEMPLATE.md
β”‚
β”œβ”€β”€ CONTRIBUTING.md
β”œβ”€β”€ CODE_OF_CONDUCT.md
β”œβ”€β”€ README.md
β”œβ”€β”€ package.json
└── vite.config.js

πŸ“ Important Directories

src/components

Reusable React components should be placed here.

Examples:

  • Navbar
  • Footer
  • Button
  • Card
  • Loading Spinner

src/pages

Page-level React components should be placed here.

Examples:

  • Home
  • About
  • Contact

src/assets

Images, icons, and other frontend assets can be stored here.

.github

Contains GitHub configuration files such as:

  • Issue templates
  • Pull Request template

πŸ“¦ package.json

Contains project dependencies and npm scripts.

🎯 Contribution Tip

Before creating a new component, check whether a similar reusable component already exists.

🏠 Home πŸ“¦ Getting Started 🀝 How to Contribute πŸ“ Project Structure πŸ› Issues & Pull Requests ❓ FAQ

Clone this wiki locally