kolyamba-mamba / metida

Процент готовности проекта

15.6%

CI

Развертка на linux машине

Есть небольшой скрипт, поднимающий сервер на unix)

Развертка на Windows машине

Для установки всех пакетов и запуска сервера:

Команды терминала:

npm install
npm start

Команды MySQL Command Line:

create database usersDB2; 
create user 'metidaSQL'@'localhost' identified with mysql_native_password by '123456';
grant all privileges on usersDB2.* to 'metidaSQL'@'localhost';

Таблицы и поля в ней создадутся автоматически

Если обновились поля в БД и у тебя интерпретатор выдает что-то вроде Error: Unknown column 'puk' in 'field list' , то тогда либо добавь новый столбец в локальную БД с соблюдением типов, либо урони ее drop table usersDB2.pukTable;

Структура проекта

Если ты пришел и не понимаешь что тут происходит, я тебе расскажу хотя бы про структуру проекта

/config

Настройки базы данных

Рекомендую создать такой же аккаунт с таким же логином и паролем(см выше)

/routes

Маршрутизация

Реализовано пока всего-лишь несколько переходов по сайту.

/controllers

Работа с регистрацией юзера

Файл, который должен соединяться с таблицей юзеров в БД и проверять на соответствие поля

/services

Непосредственная валидация на стороне сервера

/public

Лицо сайта

Ой, там нет html файлов. Возможно, я к ним еще вернусь, но не сегодня. Там лежат стили, картинки и фронтендовые скрипты вроде валидации ввода

/views

Предтрансляционные html файлы

Файлы pug(мопс ахах) браузер транслирует в html файлы. Надо перейти на реакт

/views/modules

Элементы сайта, которые должны отображаться больше, чем на одной странице.

Чтобы не копировать код(dry ofc), мы создаем отельный файлик, который инклудим с требуемой страницы. Конечно же, для наших файлов-модулей необходим и стайл модуль, поэтому кидаем такие же модульные стили в /public/css/modules

Код стайл

Да, возможно, не всем нравится за ним следить, но это важно, т.к. проект развивается, и становится все больше и больше (на момент написания было окло 1-1.5к строк), за этим достаточно тяжело следить так, что хотя бы код стайл должен быть плюс-минус одинаковым

Венгерской нотации я думаю смысла придерживаться нет (хотя это топово особенно для жабкаскрипт), но есть минимальный набор:

1. отступы: 4 пробела
2. отступы от комментов один пробел: /* вот так */ или // вот так
3. название файлов и папок(сиротам не понять) в змеином стайле: вот_так.файл
4. в то время как весь код в верблюжьем стайле: слышьЯВызываюПокемона()
5. функции должны быть с максимально понятным названием

Docker

Это контейнер

Создание контейнера

docker build .
docker images
docker run  

Теперь, если ты сделал что-то, и не смог исправить ошибку, или просто нашел баг в работе и не смог сразу поправить, возможно, стоит создать issue с этой ошибкой, чтобы она мозолила глаза и кто-нибудь(хм) ее пофиксил