structure.md

Соглашения о структуре папок

Параметры структуры папок и соглашения об именах

Структура каталога верхнего уровня

.
├── build       # Cкомпилированные файлы
├── docs        # Файлы документации
├── public      # Общие файлы 
├── src         # Исходные файлы
├── tests       # Автоматические тесты
├── tools       # Инструменты и утилиты
├── LICENSE
└── README.md

Используйте короткие имена в нижнем регистре, по крайней мере, для файлов и папок верхнего уровня, за исключением LICENSE, README.md.

---

Файлы документации

Структура каталога docs

Часто полезно включить в проект некоторые справочные данные, такие как Документация в формате Markdown (md), которая хранится в папке docs.

.
├── ...
├── docs # Файлы документации 
│ ├── conventions       # Файлы соглашения
│ ├── TOC.md            # Содержание(Table Of Contents)
│ ├── FAQ.md            # Часто задаваемые вопросы(Frequently Asked Questions)
│ ├── structure.md      # Структура файлов
│ ├── misc.md           # Разная информация
│ ├── usage.md          # Руководство по началу работы
│ └── ... # и т.д.
└── ...

---

Общие файлы

Структура каталога public

.
├── assets       # Файлы с ресурсами(изображения, шрифты и т.п.)
└── locales      # Файлы локализации(языковые переводы)

Используйте короткие имена в нижнем регистре, по крайней мере, для файлов и папок верхнего уровня. Хорошей практикой будет объединение файлов с общим типом или назначением.

Подробнее о структуре каждой папки можно посмотреть в docs/conventions.

---

Исходные файлы

Структура каталога src

.
├── components      # Файлы с компонентами
├── constants       # Файлы с константами
├── helpers         # Файлы с чистыми функциями
├── hooks           # Файлы с кастомными хуками
├── layouts         # Файлы с шаблонами
├── pages           # Файлы со страницами
├── store           # Файлы Redux
├── styles          # Файлы со стилями
├── web3            # Файлы для Web3.js
├── LICENSE
└── README.md

Используйте короткие имена в нижнем регистре, по крайней мере, для файлов и папок верхнего уровня, за исключением LICENSE, README.md.

Фактические исходные файлы программного проекта обычно хранятся внутри src папки. Кроме того, вы можете поместить их в lib (если вы разрабатываете библиотеку).

Подробнее о структуре каждой папки можно посмотреть в docs/conventions.