Инструкция для нашей команды SEALS

Базовые команды работы с папками и файлами (внимание - важно и удобно) :

Немного удобный команд для общего развития:

• Переход по папкам: cd

  Пример: нам нужно перейти в папку TestMy с проектом на диске C

  cd C:/TestMy Все просто, и так намного удобнее и быстрее переходить по папкам и создавать новые файлы и папки в проекте. Но дело хозяйское

• Создание новой папки через консоль: mkdir

  Пример: нужно создать папку views где будут хрониться все html файлы

  mkdir views Изи пизи, ничего сложного, чуть ниже вы поймете зачем я эту вещь расписываю, которая вам по идее не нужна.

• Создание нового файла через консоль: touch

  Пример: нужно создать в папке views новый html файл ( у нас будет не html, но это чуть позже - завтра)

  touch views/landingPage.html Получается если мы выполним все 3 команды по порядку, то сейчас мы находимся в папке проекта c/TestMy, создали папку фронта views и в ней добавили файл langingPage.html.

• Удаление файла через консоль: rm

  Пример: нужно удалить случайный созданный файл в общей папке проекта под названием her.html

  rm her.html После этой команды файл будет удален.

• Удаление папки через консоль: rmdir

  Пример: нужно удалить папку rautes, так как мы хотели создать папку routes в общем проекте, но сделали опечатку.

  rmdir rautes А затем можно испольщовать mkdir routes чтобы создать папку с правильным названием.

Пока все, это основные команды для того, чтобы быстро из консоли все создавать и не париться, и быть ленивой жопой и не трогать тачпад или мышь которые нахер нам как кодерам не нужны.

Подготовка visual studio code к работе

Само собой разумеется скачаем наш visual studio code с офф сайта бесплатно. Она удобно и в ней достаточно интересных расширений которые можно скачать и это упростит работу с кодом. Ниже я перечислю насколько из них:

• Настройка встроенного терминала: "terminal.integrated.shell.windows": "C:\\Program Files\\Git\\bin\\bash.exe" Данная настройка на винде, про mac не знаю, но поищу.

  Чтобы проделать это небходимо зайти в File -> Preferences -> Settings Дальше надеюсь что поймете, если нет пишите. Это обязательно настроить, чтобы можно было использовать командную строку прямо в среде разработке. Не нужно будет никаких лишних действий. И мы сразу встраивам наш git в среду разработки, и все можем делать прямо в ней.

Также установим расширения:

На панели слева есть квадратик, внизу после значка "жук в круге зачеркнутый", захоим туда ищем все перечисленные расширения и устанавливаем:

• Bracket Pair Colorizer - выделяет скобки уникальным цветом, легче читать код и ориентироваться в нем.
• Prettier - Code formatter - добавляет всякие точки и запятые после того как нажмете сохранение, выравниват код красиво и как надо.
• Node.js Modules Intellisense

Основные рабочие комнды:

1. Фоточка кода: git add . 2. Коммит подготовка истории: git push Инструкция по использованию конченого гита

У нас есть 3 ветки которые я создал:
3. Показать все ветки: git branch Ветка создается командой: git checkout -b "Name of brach"

Посмотреть историю коммитов всех веток: git bracnh -v
4. Поменять ветку: git checkout "Name of branch"
5. После создания ветки: git push --set-upstream origin Artem сам собой после add and commit 6. Тоже история коммитов: git log --oneline
# Git Commands

Инструкция по применению команд гита.

Список основных команд для работы на своей ветке:

• Запись изменений в репозиторий: git add .

  Пояснение git add .

  Данная команда фиксирует ваши изменения в коде в историю репозитория. Это позволяет нам в дальнейшем возвращаться к данному этапу разработки или предыдущим версиям продукта. Выполнять необходимо всякий раз, как справился с поставленной небольшой задачей по проекту. Точка в конце означает, что мы хотим добавить все изменения которые мы сделали. Если хочется добавить изменение только одного файла , то пишется git add и назнавие файла. Правда, нам это особо не нужно и не пригодится.

• Создать коммит к предыдущей команде, а точнее изменениям: git commit -m "Your message"

  Пояснение git commit -m "your message"

  Команда git commit берёт все данные, добавленные в индекс с помощью git add, и сохраняет их слепок во внутренней базе данных, а затем сдвигает указатель текущей ветки на этот слепок.(Это если научным языком). Для нас можно проще. Мы сделали git add . наши изменения сохранились, но только у нас. С помощью коммита идет подготовка к push, мы коммитим, а в "Your message" пишем, что мы изменили за последнее время, какую задачу решили.

• Пушим изменения ветки в наш репозиторий: git push

  Пояснение git push

  Все просто, мы сидим на github, там есть общий репозиторий в котором есть ваши ветки. Вы пушите туда все с вашими изменениями, чтобы я потом, в своем проекте мог перейдя на вашу ветку подтянуть изменения на свой компьютер, а затем проверив мержить это в главную ветку. Если эта команда не работает, то скорее всего вы создали свой проект только что или у вас новая ветка и вас попросит ввести что-то вроде git push origin Nikita , но это уже мелочи, по ходу разберемся.

• Проверка статуса: git status

  Пояснение git status

  Этой командой можно увидеть сделали вы git add или git commit. На случай когда вы вроде их ввели , но не побратили внимание, что они не сработали по каким-то причинам. Если вы не сделали git add . то все файлы буту красными, а если сделали, но не использовали git commit -m "message", то они будут зелеными. Также просто можно отслеживать файлы в которых произведены изменения. Эта команда используется постоянно, так что запоминайте.

Список команд для работы с ветками:

• Удаление ветки: git branch -D "Name of your branch"

  Пояснение git branch -D "Name of your branch"

  Все просто, данной командой можно удалить любую созданную ветку в проекте вместе со всеми ее изменениями и историей. Нам возможно пригодиться если что-то напортачим с ветками, создадим новые, а старые будут мозолить глаза.

• Создание ветки и сразу переключение на нее: git checkout -b "Name of your branch

  Пояснение не требуется

• Просмотре истории последних коммитов: git branch -v

  Пояснение git branch -v

  Данная команда выводит на экран все ветки в проекте и последние коммиты которые мы делали, очень удобно. Так же все существующие ветки без истории коммитов можно вывести командой git branch

• Переключение между ветками: git checkout "Name of branch"

  Пояснение git checkout "Name of branch"

  Возможность передвижения между нашими ветками. Легко запомнить, так-как название нашего проекта такое же.

• git pull, git merge - не поясняю, это чисто для меня пока что.

Instructions for the project

Что нужно установить, перед тем как приступать к работе:

• Консоль git(gitbash - название после установки): вчера убедились, что у всех врое есть, но на всякий случай если что произойдет с вашими системами и комьютерами перед поездкой.
• Nodejs v8.11.2 - можно и выше, сейчас у меня на системе стоит именно эта версия,и все же я не думаю, что будут конфликты если вы установите самую последнюю версию. По крайней мере раньше проблем никаких не было.
• MySQL или Mongodb: пока еще не определился какую базу данных будем использовать. Склоняюсь все таки к mySql, так что установите пока ее себе все на компьютеры. Надеюсь справитесь. Будут вопросы по установке пишите мне в личку.
• Linux Ubuntu - для тех у кого еще не стоит или нет MAC. Пока тоже под большим вопросом, и не нужно устанавливать. Я просто читал там в общем чате про, то, что нам дадут свой сервер использовать как хост, надо будет почитать про это подробнее и возможно нам пригодиться именно linux. Но пока не дергаемся, это больше мысли в слух.

Установка, запуск и работа с проектом

• После того, как сделали git clone проекта: npm install или проще npm i

Пояснение npm install

Данная команда позволяет установить все зависимости нашего проекта. В каждом проекте с nodejs есть папка node_modules. Это модули написанные другими прогерамми по сути дела их называют пакетами. Короче разный функционал для того, чтобы мы могли пользоваться nodejs используя чистый js и собирать на нем веб проекты, работать с бэком и короче много чего еще , что вам не нужно понимать для хакатона. Короче вы используете его , чтобы он считал все зависимости в файле package.json и установил их на ваш компьютер, и только тогда все будет работать.
• Как только сделали npm i можно запустить проект: node server.js

  Пояснение node server.js

  В нашем проекте будет основной файл для запуска проекта. Я его назвал server.js. Чтобы запустить проект и увидеть его на порту 8080 нужно использовать эту команду. Правда, все изменения не будут видны после перезапуска страницы. Нужно будет останавливать сервер (ctrl + c), и снова запускать команду.

• Другой удобный способ запуска проета:

  nodemon server.js

  Пояснение nodemon server.js

  По сути дела выполняет тоже самое, что и node server.js, единственное отличие, вы можете редактировать свой фронт и сразу видеть изменения в браузере после перезагрузки страницы, не отключаясь от сервера. Что касается работы с бэком не помню. Возможно также нужно будет перезапускать сервер. Чтобы использовать эту команду необходимо установить nodemon командой npm i -g nodemon , где "-g" означает global. Все установики лучше производить их консоли, но находясь в папке проекта.

Правила оформления кода

• Все страницы которые мы создаем в папке views, за исключением layout, мы называем в правильном порядке: namePage - пример langingPage.hbs
• Все классы на странице которую вы создаете называть в фармате nameAbriviationOfPage. Например, если у нас landingPage, то все ид и классы будут назвны в формате namelp, где name - имя которое вы придумали, а ,lp - сокращение landing page, типо указателя , что мы работаем именно с этой страницей. Зачем это делать, чтобы потом не было конфликтов в css файлах и других страницах из-за одинаковых названий классов и идишников при мержах.
Ну и само собой для каждой страницы свой css файл в котором тоже все эти классы и иди с указателями на ту страницу котору мы делаем. Пока так пробуем и смотрим, как такой формат работы у нас получится.

Работа с mySql. Команды и подсказки для "Влада".

Основные команды для работы с mySQL

• Показать все базы данных: show databases;
• Выбрать определенную базу данных для работы с ней: use "name of a database"
• Показать все таблицы в db: show tables;
• Показать логическую структуру таблицы: describe "name of a table"
• Создать таблицу: create table (....)

  Пример

  create table users (id int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY, fio varchar(250) NOT NULL, nickname varchar(250) NOT NULL, password int(10) NOT NULL, email varchar(250) NOT NULL );

• Создать и связать таблицы: constraint fk foreign key(id) references users(id)

  Пример

  create table events (event_id int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY, longit int(20) NOT NULL, lotit int(20) NOT NULL, nameOfEvent varchar(250) NOT NULL, info varchar(250) NOT NULL, id int(10) NOT NULL, constraint fk foreign key(id) references users(id));

• Добавить записи в таблицу: insert into "nameOftable" values (...)

  Пример

  insert into users(fio, nickname, password, email) values ( "Krushenitskii Vladislav Andreevich", "FoxBuka", "1995", "krushenitskii@gmail.com"), ("Popovichnko Mark Andreevich", "Kapo", "1234", "kapo@gmail.com");

• Выбрать всех пользователей из таблицы users: select * from users

  Пример

  select * from users
  select fio, nickname, email from users where nickname ="FoxBuka";

• Выборка из двух таблиц: select nameOfEvent, info, nickname from events join users on (events.id = users.id) where users.id ="1";