20 lines
4.2 KiB
Markdown
20 lines
4.2 KiB
Markdown
# WESP
|
|
|
|
Если вы открыли этот файл, вы уже на полпути к пониманию того, что перед вами вообще какой-то проект. Не обязательно хороший и не обязательно плохой — просто проект, и в этом, если задуматься, тоже есть определённая ценность, потому что вообще-то не у каждого есть проект, а у вас вот есть, и это уже неплохо с точки зрения наличия чего-то.
|
|
|
|
**WESP** — это название. За названием, как водится, стоит какая-то идея, а за идеей — код. Код лежит в папках; папки, в свою очередь, лежат там, где их положили. Отдельные вещи можно поискать в **`app/`**, если вам вдруг понадобится не просто созерцать структуру, а что-то с ней делать, хотя делать не обязательно: иногда достаточно просто знать, что оно где-то есть.
|
|
|
|
Если уж совсем по-человечески: это софт для кормления на ферме — рецепты и рейсы, миксеры и кормораздатчики, терминалы на планшетах, факт загрузки и отчёты СП-20, синхронизация между сервером и полем. В K-hub есть **план на день** (пропуски, замены, коррекция СВ%), **отклонения** при загрузке и зачатки **аналитики** — всё это не магия, а файлы в репозитории, просто их много, и мы сознательно не превращаем README в каталог достижений.
|
|
|
|
Запуск, когда дойдут руки и настроение, в общих чертах выглядит так: поставить зависимости как обычно принято в вашем мире (часто **`pip install -r requirements.txt`**), потом **`python run.py`**, потом открыть браузер туда, куда обычно открывают, если не знаете точный адрес — попробуйте **`http://127.0.0.1`**, вдруг совпадёт. Не совпадёт — ну значит не совпадёт, бывает.
|
|
|
|
**Чистая установка на Linux-сервер:** `sudo bash scripts/install_fresh.sh /opt/wesp /opt/wes` — см. **`docs/README.full.md`** и **`install/wesp.env.example`**.
|
|
|
|
Настройки в целом живут в **`config.py`**, переменные окружения начинаются с **`WESP_`**, если это важно в вашей вселенной. Тесты, для тех кому это важно, гоняются через **`python3 tests/run_tests.py all`** (или интерактивное меню без аргументов). Остальное — по ситуации, по ощущениям и по тому, что написано в других файлах, которых много, и перечислять их все здесь было бы не в духе минимальной документации, которую мы как раз и стараемся не раздувать, хотя получается с переменным успехом.
|
|
|
|
Если нужна не вода, а плотнее — **`docs/`**: **[docs/README.md](docs/README.md)** (оглавление), glossary, pages, architecture; дорожная карта — **`docs/ROADMAP.md`**. Папка `docs/` в git не коммитится (локально). Если нет — ничего страшного, мир шире любого README.
|
|
|
|
---
|
|
|
|
*Конец важной части. Дальше могло бы что-то ещё быть, но в рамках заявленного баланса «минимум смысла — максимум слов» мы на этом, пожалуй, остановимся.*
|