Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 1.18 KB

project-structure.md

File metadata and controls

47 lines (28 loc) · 1.18 KB

Project Structure

Provide a high-level overview of the project structure. Provide examples of how the project structure is organized. You might include code snippets or screenshots of the project directory to help illustrate your points. The main folder structure of the project is as follows:

├── public  
├── src  
│ ├── components  
│ ├── helpers  
│ ├── pages  
│ │ ├── api  
│ ├── styles  

Folders

folder

Describe the purpose and contents of each folder in the project structure. For example, you might have a folder for components, a folder for styles, and a folder for utility functions.

For example, you can have the following sections for your project.

public

Description of public folder

src

Description of src folder

components

Description

helpers

Description

...

Naming conventions

Explain the naming conventions that were used when organizing the project structure. For example, when naming a new folder or a file.

Project organization

Explain any special considerations you have for the project. For example, you might have a specific way of organizing your Redux store.