Как запустить проект с github

Как запустить проект с gitub?

1) Скачал проект для vue js
2) Создал чистый проект (при помощи vue cli установил чистую сборку vue js)
3) Залил с заменой скаченные файлы с гитхаба
4) Попытался запустить проект командой npm run serve, но вылетает ошибка
5) Затем посмотрел в package.json команды для запуска:

"dev": "cross-env NODE_ENV=development webpack-dev-server --open --inline --hot", "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"

Но не понял как все таки запустить проект

Вот кстати ошибка, перевести мне удалось, но понимания не прибавилось:

No configuration file found and no entry configured via CLI option.
When using the CLI you need to provide at least two arguments: entry and output.
A configuration file could be named ‘webpack.config.js’ in the current directory.
Use —help to display the CLI options.

• Вопрос задан более трёх лет назад
• 1886 просмотров

Как запустить проект с GitHub?

Вот так выглядит проект после импорта, здесь нет кнопки запуска проекта.

Отслеживать
задан 27 апр 2016 в 16:47
10.9k 18 18 золотых знаков 62 62 серебряных знака 128 128 бронзовых знаков
Что именно значит все равно не открывается ? Клещами из вас тянуть ошибки, скриншоты.
27 апр 2016 в 17:00

@AlekseyTimoshchenko, у вас, возможно, не указаны пути к папкам, где лежит сам код, вот и студия не знает что запускать. Вы бы хоть на скрине раскрыли папки бы, что ли.

27 апр 2016 в 20:30
@ЮрийСПб добавил
27 апр 2016 в 20:40
@AlekseyTimoshchenko, ну. Может надо ещё и градл файлы добавить.
27 апр 2016 в 20:44

@ЮрийСПб Да, но по ссылке с гита с которой я качал проект, там нет гдадл файлов. Я так понимаю их самому нужно собрать? Я раньше делал Build — Rebuild project, но в этом проекте есть Build но нет Rebuild project. А как можно еще собрать градл файлы?

Работа с Git через консоль

Задача: форкнуть репозиторий в GitHub, создать ветку и работать с кодом.

Сразу появляется много вопросов — что такое GitHub, какие для этого нужны команды, зачем, а главное, как всем этим пользоваться? Давайте разберёмся.

Когда мы пишем код, мы постоянно туда что-то добавляем, удаляем, и иногда всё может ломаться. Поэтому перед любыми изменениями стоит сделать копию проекта. Если собирать проекты в папки с именами проект1 , проект1_финал и проект2_доделка , вы быстро запутаетесь и точно что-нибудь потеряете. Поэтому для работы с кодом используют системы контроля версий.

Система контроля версий — программа, которая хранит разные версии одного документа, позволяет переключаться между ними, вносить и отслеживать изменения. Таких систем много и все они работают по принципу компьютерной игры, где вы можете вернуться к месту сохранения, если что-то пошло не так.

Git — самая популярная система контроля версий. С Git можно работать через командную строку (или терминал). В каждой системе своя встроенная программа для работы с командной строкой. В Windows это PowerShell или cmd, а в Linux или macOS — Terminal. Вместо встроенных программ можно использовать любую другую — например, Git Bash в Windows или iTerm2 для macOS.

Как работает терминал: мы вводим команду и получаем ответ компьютера — или всё получилось, или где-то ошибка, или нужно ввести что-то ещё — например, пароль. Поэтому большая часть этой инструкции состоит из команд для терминала. Сначала будет непривычно, но вам понравится.

Но давайте по порядку — установим Git на компьютер.

Устанавливаем и настраиваем Git

Windows. Скачайте Git для Windows, запустите exe-файл, следуйте инструкциям.

macOS. Скачайте Git для macOS и запустите dmg-файл. Если он не запускается, зайдите в Системные настройки — Безопасность и нажмите кнопку Open anyway (Всё равно открыть).

Linux. Установите Git через встроенный менеджер пакетов. Если у вас Ubuntu, используйте команду sudo apt-get install git . Команды для других дистрибутивов можно посмотреть здесь.

Как проверить, что Git установился

Откройте терминал и введите команду

git --version 

Если Git установлен, то вы увидите номер версии, например, 2.35.1 .

Настраиваем Git

Теперь нужно ввести имя и адрес электронной почты, чтобы ваши действия в Git были подписаны, а ещё для привязки к GitHub.

Добавить имя (введите его внутри кавычек):

git config --global user.name "ваше имя" 

Добавить электронную почту (замените email@example.com на вашу почту):

git config --global user.email email@example.com 

Опция —global значит, что имя и почта будут использоваться для всех ваших действий в Git. Если вы хотите менять эту информацию для разных проектов, то вводите эти же команды, только без опции —global .

Регистрируемся на GitHub

GitHub (или Гитхаб) — веб-сервис на основе Git, который помогает совместно разрабатывать IT-проекты. На Гитхабе разработчики публикуют свой и редактируют чужой код, комментируют проекты и следят за новостями других пользователей.

Профиль на Гитхабе и все проекты в нём — ваше публичное портфолио разработчика, поэтому нужно завести профиль, если у вас его ещё нет.

1. Зайдите на сайт https://github.com и нажмите кнопку Sign up.
2. Введите имя пользователя (понадобится в дальнейшей работе), адрес электронной почты (такой же, как при настройке Git) и пароль.
3. На почту придёт код активации — введите на сайте.
4. Появится окно с выбором тарифного плана. Если вы пользуетесь Гитхабом для учёбы, то укажите, что профиль нужен только для вас и вы студент.
5. Опросы и выбор интересов можно пропустить.

На этом всё — вы зарегистрировались и у вас есть собственный профиль.

Устанавливаем SSH-ключи

Чтобы получить доступ к проектам на GitHub со своего компьютера и выполнять команды без постоянного ввода пароля, нужно, чтобы сервер вас узнавал. Для этого используются SSH-ключи.

SSH — протокол для безопасного соединения между компьютерами.

SSH-ключ состоит из двух частей — открытого и закрытого ключа. Открытый ключ мы отправляем на сервер. Его можно не прятать от всех и не переживать, что кто-то его украдёт, потому что без закрытого ключа он бесполезен. А вот закрытый ключ — секретная часть, доступ к нему должен быть только у вас. Это важно.

Мы будем подключаться к GitHub по SSH. Это работает так:

1. Вы отправляете какую-то информацию на GitHub, который знает ваш открытый ключ.
2. GitHub по открытому ключу понимает, что вы это вы, и отправляет что-то в ответ.
3. Только вы можете расшифровать этот ответ, потому что только у вас есть подходящий закрытый ключ.

А чтобы подключиться к GitHub с помощью SSH-ключа, сначала нужно его создать.

Проверяем SSH-ключи

Перед созданием нового SSH-ключа проверим, есть ли на компьютере другие ключи. Обычно они лежат в папке с названием .ssh — поэтому посмотрим, есть ли в ней что-то, с помощью команды в терминале:

ls -al ~/.ssh 

Если у вас уже есть SSH-ключ, то в списке будут файлы с именами вроде id_rsa.pub , id_ecdsa.pub или id_ed25519.pub . А если терминал ругается, что директории ~/.ssh не существует, значит, у вас нет SSH-ключей. Давайте это исправим.

Создаём новый SSH-ключ

Откройте терминал и скопируйте туда эту команду. Не забудьте подставить в кавычки почту, на которую вы регистрировались на Гитхабе.

ssh-keygen -t ed25519 -C "your_email@example.com" 

ed25519 — это алгоритм для генерации ключей. Если ваша система не поддерживает алгоритм ed25519 (и вы увидели ошибку), используйте немного другую команду с алгоритмом rsa :

ssh-keygen -t rsa -b 4096 -C "your_email@example.com" 

Терминал спросит, куда сохранить ключ. Если не хотите менять имя файла, которое предлагает терминал, просто нажмите Enter.

> Generating public/private имя-ключа key pair. > Enter a file in which to save the key (/c/Users/ваш-профиль/.ssh/id_имя-ключа):*[Press enter]* 

Теперь нужно добавить пароль, которым будет зашифрован ваш ключ. Это стоит сделать, иначе в дальнейшем могут быть проблемы с настройкой, да и так просто безопаснее.

В результате создаётся новый SSH-ключ, привязанный к вашей электронной почте.

Создание ключа по шагам:

Добавляем SSH-ключ в ssh-agent

ssh-agent — программа для хранения и управления SSH-ключами. Давайте запустим её и добавим туда наш SSH-ключ. Запускаем командой eval «$(ssh-agent -s)» :

eval "$(ssh-agent -s)" 

Если в ответ терминал покажет надпись «Agent pid» и число — значит, всё ок, агент запущен.

Теперь добавим наш ключ командой.

ssh-add ~/.ssh/id_ed25519 

Если у вашего ключа другое имя, замените название id_ed25519 именем файла с ключом (это правило применяется и дальше в инструкции). Если вы устанавливали пароль на ключ, введите его два раза после ввода команды ssh-add (терминал подскажет, когда это сделать).

Теперь, если всё хорошо, появится надпись Identity added — значит, можно переходить к добавлению ключа на GitHub.

Копируем SSH-ключ

Чтобы добавить ключ на GitHub, нужно сначала его скопировать из вашего файла командой clip . Вы не увидите ключ на экране, но он появится в буфере обмена, и его можно будет вставить на Гитхаб.

clip < ~/.ssh/id_ed25519.pub 

Команда clip может не сработать на вашем компьютере, тогда есть два способа узнать ключ — простой и сложный.

Сложный способ. Найдите скрытую папку .ssh , откройте файл id_ed25519.pub в текстовом редакторе и скопируйте его содержимое.

Простой способ. Введите команду ниже и ключ появится прямо в терминале — его нужно вручную скопировать в буфер обмена. Ключ начинается с ssh-ed22519 или ssh-rsa (или похожей строки) — поэтому копируйте строку прямо с самого начала.

~ cat ~/.ssh/id_ed25519.pub ssh-ed25519 AAAAC3NzaCZvnr4ax+Fr shklyar@htmlacademy.ru 

Не копируйте этот ключ из статьи — он уже не работает.

Добавляем SSH-ключ на GitHub

Это нужно сделать, чтобы GitHub вас узнавал.

Перейдите на страницу для работы с ключами в вашем профиле на GitHub и нажмите кнопку New SSH key.

В поле Title нужно добавить название нового ключа. Например, если вы используете Mac, вы можете назвать ключ MacBook Air, или, если ключ для курсов Академии, то Academy. А ключ, который вы скопировали на прошлом шаге, вставьте в поле Key.

Не копируйте ключ со скриншота — он уже не работает.

Теперь нажмите кнопку Add SSH key и, если потребуется, введите свой пароль от GitHub, чтобы подтвердить сохранение. Если всё сделано верно, новый ключ появится в списке на странице https://github.com/settings/keys.

Теперь мы можем поработать с проектом в репозитории.

Что такое репозиторий

Репозиторий — папка с файлами вашего проекта на сервере GitHub. Так вы можете работать с проектом откуда угодно, не переживая, что какие-то файлы потеряются — все данные останутся в репозитории.

Если над проектом работает несколько программистов, сначала создаётся мастер-репозиторий — это общий репозиторий с рабочей версией проекта. А каждый программист работает с форком — то есть полной копией мастер-репозитория. В форке вы можете безнаказанно менять код и не бояться что-то сломать в основной версии проекта.

Делаем форк мастер-репозитория

Заходим в нужный репозиторий и нажимаем на «вилку» с надписью fork.

Появится окно Create a new fork — проверьте, что он называется так, как вам нужно, и жмите кнопку Create fork. Через пару секунд всё готово.

Клонируем форк на компьютер — git clone

Клонировать форк — значит скачать его, чтобы работать с кодом на своём компьютере. Тут нам и пригодится SSH.

Открываем терминал и переходим в папку с будущим проектом — для этого используем команду cd your-project . Если вы хотите, чтобы проект лежал в папке device , введите

cd device 

Если такой папки на компьютере нет, то сначала введите md your-project , чтобы создать эту папку, а затем cd your-project . Когда перейдёте в папку, введите команду git clone для клонирования репозитория:

git clone git@github.com:your-nickname/your-project.git 

Замените your-nickname на ваше имя пользователя на GitHub, а your-project на название проекта. Проще всего их найти прямо наверху страницы репозитория.

Если вы правильно настроили SSH-ключи, Git скопирует репозиторий на ваш компьютер.

➜ device git clone git@github.com:academy-student/1173761-device-34.git Клонирование в «1173761-device-34»… remote: Enumerating objects: 15, done. remote: Counting objects: 100% (15/15), done. remote: Compressing objects: 100% (14/14), done. remote: Total 15 (delta 0), reused 15 (delta 0), pack-reused 0 Получение объектов: 100% (15/15), 145.07 КиБ | 900.00 КиБ/с, готово. 

Если вы видите ошибку Error: Permission denied (publickey) , скорее всего, вы ошиблись в настройке SSH-ключа. Вернитесь в этот раздел инструкции и повторите процесс настройки.

Кстати, если вы хотите, чтобы название папки с проектом у вас на компьютере отличалось от имени репозитория, можете дополнить команду клонирования, добавив в конце другое название:

git clone git@github.com:_your-nickname_/_your-project_.git folder_name 

Теперь на вашем компьютере в папке your_project или в той, название которой вы указали, находится полная копия репозитория c GitHub.

В каждом репозитории есть как минимум одна основная ветка, которую создаёт сам Git — она называется master . Обычно в ней хранят проверенную версию программы без ошибок.

А если вы хотите исправить ошибку в коде или добавить что-то в проект, но не хотите сломать код в основной ветке, нужно создать новую ветку из master и работать из неё. Каждая ветка — что-то вроде второстепенной дороги, которая затем снова соединится с основной.

Создаём новую ветку — git branch

Откройте терминал и введите команду

git branch 

Она показывает список веток, с которыми мы работаем в проекте, и выделяет текущую. Если мы находимся в master , то создаём новую ветку командой

git checkout -b имя-новой-ветки. 

➜ 1173761-device-34 git:(master) git checkout -b task1 Переключено на новую ветку «task1» ➜ 1173761-device-34 git:(task1) 

Если текущая ветка не master , переключитесь на неё с помощью команды checkout . После git checkout надо указать название нужной ветки.

git checkout master 

Мы делаем это, чтобы новая ветка содержала свежую рабочую версию проекта. Если вы ошиблись в названии, например, допустили опечатку, вы можете изменить название ветки с помощью команды:

git branch -m старое-имя-ветки новое-имя-ветки. 

Сохраняем изменения — git add

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

Если вы хотите сохранить изменения не во всех файлах, для начала введите команду git status . Она покажет текущее состояние в вашей ветке, а именно список с названиями изменённых файлов, если они есть, и укажет на те, которые ожидают записи и сохранения (обычно они выделены красным цветом).

Чтобы сохранить все изменения разом, используйте команду

git add -A 

Чтобы сохранить изменения только отдельных файлов, укажите их имена вручную. Например, если вы изменили файл index.html , введите

git add index.html 

Если название очень длинное, вы начните его писать, нажмите Tab и терминал сам предложит продолжение пути к файлу.

Делаем коммит — git commit

Сделать коммит — значит зафиксировать все сохранённые изменения и дать им название. Это делается с помощью команды commit

git commit -m "ваше сообщение" 

Текст сообщения должен быть лаконичным и вместе с этим сообщать о том, что делает коммит (внесённые изменения). Например,

• Добавляет имя наставника в Readme
• Вводит функцию сортировки изображений
• Правит ошибку в поиске городов на карте

Отправляем изменения на GitHub — git push

Сохранённые изменения пока не видны коллегам, потому что находятся в нашем локальном репозитории. Нужно отправить коммиты на GitHub. Для этого введите команду

git push origin название-текущей-ветки 

Где origin означает репозиторий на компьютере, то есть ваш форк. Слово origin — часть команды, не меняйте это название на своё.

Создаём пулреквест

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

Если к коду нет вопросов, пулреквест принимается. Если нужно что-то исправить — отклоняется, и придётся исправить код и снова пройти цепочку git add — git commit — git push . Если вы и дальше работаете в той же ветке, а пулреквест ещё не принят, все ваши изменения автоматически добавятся в пулреквест, созданный из этой ветки после команды git push origin название-текущей-ветки .

Чтобы создать пулреквест, зайдите на страницу вашего форка на GitHub. Вверху появилась плашка Compare & pull request, а ещё можно зайти на вкладку Pull Requests.

Нажмите на неё и окажетесь на странице открытия пулреквеста. Проверьте описание и нажмите Create pull request.

Готово, теперь ждём остаётся ждать одобрения пулреквеста или комментариев к нему.

Синхронизируем репозитории

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

Теперь код в мастер-репозитории обновился, а в вашем форке нет, вы ведь не обновляли свою версию репозитория с тех пор, как клонировали её себе на компьютер. Приведём форк в актуальное состояние.

В локальном репозитории переключаемся на ветку master .

git checkout master 

Забираем изменения из ветки master мастер-репозитория

git pull git@github.com:academy-student/1173761-device-34.git master 

Отправляем изменения уже из своей ветки master в ваш форк на GitHub с помощью команды

git push origin master 

Готово, теперь форк и оригинальный репозиторий находятся в актуальном состоянии.

Словарик

Система контроля версий — программа, которая хранит разные версии одного документа, позволяет переключаться между ними, вносить и отслеживать изменения.

Git — самая популярная система контроля версий. С Git можно работать через терминал.

Как работает терминал: мы вводим команду и получаем ответ компьютера — или всё получилось, или где-то ошибка, или нужно ввести что-то ещё.

GitHub (или Гитхаб) — веб-сервис, основанный на Git, который помогает совместно разрабатывать IT-проекты. На Гитхабе разработчики публикуют свой и редактируют чужой код, комментируют проекты и следят за новостями других пользователей.

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

ssh-agent — программа для хранения и управления SSH-ключами.

Репозиторий — папка с файлами вашего проекта на сервере GitHub или у вас на компьютере.

Мастер-репозиторий — это общий для всей команды репозиторий с рабочей версией проекта.

Форк — полная копия мастер-репозитория, в которой вы можете безопасно работать.

Клонировать форк — скачать его командой git clone , чтобы работать с кодом на своём компьютере.

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

«Доктайп» — журнал о фронтенде. Читайте, слушайте и учитесь с нами.

Читать дальше

5 частых ошибок при работе с Git

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

• 27 августа 2023

GitHub Desktop: обзор и первая настройка

Самая короткая инструкция о том, как сохранить файлы в GitHub и ничего не сломать. И самое главное — никакой консоли, всё через окошки и с помощью мышки. Для этого используем GitHub Desktop.

Внимание! GitHub Desktop не работает на Windows 7×32, поэтому если у вас эта версия системы, обновитесь до Windows 10 или воспользуйтесь программой GitKraken.

В этой статье идёт рассказ о системах контроля версий. Если вы совсем ничего о них не знаете, прочитайте статьи «Словарь терминов для Git и GitHub» и «Введение в системы контроля версий», чтобы понять терминологию и разобраться, зачем мы вообще это делаем.

• 7 августа 2023

Как склеить коммиты и зачем это нужно

Когда вы открываете пулреквест и ваш код смотрят и комментируют другие, бывает нужно что-то исправить. Обычно такие изменения мы комментируем сообщением вроде «Увеличил шрифт на 2px » или «Поменял оттенок фона в шапке». Такие маленькие изменения интересны, только пока они в пулреквесте. Ревьювер (человек, который смотрит ваш код), может легко узнать, что и когда вы изменили, а не читать весь diff заново, а вы можете легко откатить коммит, если он не нужен. Но когда приходит время вливать пулреквест, эти маленькие коммиты теряют свою ценность. Поэтому лучше их склеить в один.

• 14 июня 2023

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

Работа с Git через терминал — это обязательная часть практики фронтендера. Однако для начинающих разработчиков этот инструмент может показаться сложным. Чтобы вам было проще учиться, мы собрали основные команды для работы с Git.

☝ В некоторых командах мы будем писать URL-адрес удалённого репозитория и название проекта в квадратных скобках, вот так — [ссылка на удалённый репозиторий] . Мы делаем это только для наглядности. Вам квадратные скобки ставить не нужно.

• 22 февраля 2023

Как бесплатно залить сайт на GitHub Pages

Допустим, вы сделали какой-то проект, например, собрали себе портфолио по шаблону, и теперь хотите выложить его в интернет. Если вы использовали только HTML и CSS, то необязательно платить деньги, чтобы загрузить сайт куда-то. Вы можете бесплатно выложить сайт на сервис GitHub Pages. Всё, что нужно — аккаунт на Гитхабе.

• 29 ноября 2022

Регистрация на GitHub

Создание нового аккаунта на GitHub состоит всего из 10 шагов — и вся регистрация занимает меньше пяти минут.

�� Обратите внимания, что интерфейс Гитхаба регулярно меняется, так что внешне он может отличаться, когда вы читаете эту статью.

Начало регистрации. Так выглядит главный экран Гитхаба, когда вы не зарегистрированы. Главное, что вам нужно заметить — большое поле для ввода почты и зелёная кнопка. Вводите свой адрес и переходите на следующий шаг.

Ввод почты. На следующем шаге начинается регистрация. Подтвердите свою почту с прошлого шага и нажмите Continue (Продолжить).

Пароль. Придумайте сложный пароль, чтобы его никто не взломал. Например, Гитхаб просит, чтобы в пароле было не меньше 15 символов или 8 символов, но тогда должны быть и латинские буквы, и цифры.

Имя профиля. Теперь выберите имя вашего профиля — оно будет использоваться в интерфейсе, в коммитах и комментариях. То есть именно так вас будет видеть любой пользователь Гитхаба. Для разработчика Гитхаб вместо визитки, так что выбирайте что-нибудь приличное, лучше, если ник будет совпадать с вашими никнеймами на других сайтах.

Если имя недоступно, Гитхаб вам об этом скажет. А если доступно — жмите Continue.

Рассылки. Дальше Гитхаб спросит, хотите ли вы подписаться на рассылку об обновлениях. Впечатайте латинскую У, если хотите, или n, если письма вам не нужны. Готовы спорить, мы знаем, что вы выберете.

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

Подтверждение почты. После капчи вам придёт письмо с кодом на почту. Введите его на следующей странице.

Вот здесь. Главное — не ошибайтесь.

Общая информация о вас и вашей команде. Если вы регистрируете аккаунт для себя, выбирайте Just me. Второй пункт — студент вы или учитель. Выбирайте «Студент», если вы не учитель.

Интересы. Дальше Гитхаб спросит вас об интересах — то есть о том, зачем вы регистрируете аккаунт. Из вариантов:

• Совместная разработка и код ревью.
• Автоматизация. CI/CD, API и другие админские вещи.
• Безопасность. Двухфакторная аутентификация, ревью, сканирование кода и списки зависимостей.
• Приложения. Выбирайте, если будете использовать GitHub Mobile, CLI, Desktop.
• Управление проектами. Проекты, метки, ишьи, вики и другие управленческие дела.
• Управление командами. Организации, приглашения, роли, домены.
• Сообщество. Выбирайте, если Гитхаб интересен вам как соцсеть.

Вы можете выбрать несколько пунктов или пропустить и не указывать ничего, для этого пролистайте страницу вниз для кнопки Skip customization.

Выбор тарифа. На выбор бесплатный тариф или платный GitHub Pro. Практика показывает, что для большинства личных проектов хватит бесплатного тарифа. В сентябре 2022 в него входили:

• Безлимитное количество репозиториев.
• 2000 минут CI/CD в месяц.
• 500 мегабайт места в хранилище пакетов.
• Поддержка сообщества.

Выбор тоже можно пропустить, тогда у вас будет бесплатный тариф.

Всё готово. Теперь у вас есть аккаунт. Можете создать репозиторий и работать с ним, или склонировать чужой. А для работы у вас есть несколько удобных вариантов:

• 28 сентября 2022

Работа с Git в Visual Studio Code

Если вы вёрстаете сайты или пишете код в редакторе Visual Studio Code, то Git за пять минут настраивается прямо внутри редактора. Не нужно запоминать команды для консоли, не нужно тыкать в лишние приложения.

Следуйте инструкции и всё получится.

• 16 сентября 2022

Markdown за 5 минут

Маркдаун, он же markdown — удобный и быстрый способ разметки текста. Маркдаун используют, если недоступен HTML, а текст нужно сделать читаемым и хотя бы немного размеченным (заголовки, списки, картинки, ссылки).

Главный пример использования маркдауна, с которым мы часто сталкиваемся — файлы readme.md , которые есть в каждом репозитории на Гитхабе. md в имени файла это как раз сокращение от markdown.

Другой частый пример — сообщения в мессенджерах. Можно поставить звёздочки вокруг текста в Телеграме, и текст станет полужирным.

Версии маркдауна отличаются, поэтому перепроверьте, какую вы используете.

• 5 октября 2021

Шпаргалка по Git. Решение основных проблем

Поговорим о решении проблем с Git.

• 11 декабря 2020

Полезные команды для работы с Git

Работа с Git через терминал — это обязательная часть практики каждого современного фронтенд-специалиста. Однако, для начинающих это может показаться сложным. Чтобы упростить процесс обучения, мы собрали для вас все самые необходимые команды, которые пригодятся в работе с Git на первое время.

• 1 января 2020

Кофе-брейк #100. Как запустить проект с открытым исходным кодом на GitHub

Источник: FreeCodeCamp Разработчики всего мира используют GitHub, чтобы делиться своими проектами. В этой статье я попытаюсь дать несколько советов, которые помогут вам создать отличный проект с открытым исходным кодом. Вы также можете использовать эти советы для создания хакатонных проектов. Совсем недавно я оказался на желанной странице GitHub Trending. Я был вторым трендовым разработчиком на всем GitHub, а также в разделе Python, что стало для меня очень приятным сюрпризом. Меня также упомянули в ежедневном информационном бюллетене GitHub после того, как я перевел один из моих проектов в open source. Если интересно, вы можете посмотреть мой репозиторий здесь.

Найдите свою мотивацию

Пытаться попасть в раздел GitHub Trending практически невозможно. Во время определения трендов в GitHub используются гораздо более сложные алгоритмы, чем просто количество звезд. Чтобы попасть в тренды, вам нужна сильная мотивация. Что ж, для начала вы можете участвовать в хакатонах, создавать проекты и экспериментировать с другими проектами. И вскоре вы найдете что-то, что можно было бы превратить в библиотеку или сделать утилитой, и так далее. Ваша мотивация для создания проекта может исходить откуда угодно. Например, я ежедневно изучаю новые статьи по машинному обучению на arXiv (архив статей с открытым доступом) и читаю те, которые мне интересны. Одна статья, которую я прочитал, побудила меня создать собственный Python package. В другой раз я был на хакатоне по обучению модели машинного обучения и захотел поучаствовать в чем-то подобном. Затем наша команда решила создать еще один проект с открытым исходным кодом под названием TF-Watcher. Как видите, всегда можно найти какие-либо проблемы, над которыми можно поработать, когда вы ищете цель для своего проекта. Обратите внимание — когда я говорю, что у вас должна быть сильная мотивация, я не имею в виду, что проект должен быть действительно огромным или очень сложным. Это может быть вполне простой проект, который облегчает жизнь разработчиков. Подумайте об этом так: если бы был проект, подобный тому, который вы хотите разработать, вы бы его сами использовали? Если ответ положительный, то у вас достаточно мотивации для создания проекта, независимо от его размера и сложности. Не так давно один парень из Окленда, штат Калифорния, нарушил веб-разработку по всему миру, удалив всего 11 строк кода. Возможно, вы слышали о left-pad — очень маленьком пакете npm с открытым исходным кодом, содержащем всего 11 строк. Но оказывается, его использовали множество разработчиков по всему миру.

Изучите свою идею

Как только вы найдете проблему и у вас появится достаточно мотивации, чтобы начать работать над ней, то, скорее всего, вам захочется потратить немало времени на свое исследование. Но перед этим попытайтесь ответить на несколько вопросов:

Существует ли уже подобный проект или инструмент?

Если аналога еще нет и в нем есть необходимость, тогда приступайте к созданию. Если что-то подобное существует, хорошо разработано и активно используется, возможно, вам стоит поискать другую идею. На GitHub есть огромное количество проектов с открытым исходным кодом, и довольно часто там можно найти репозиторий, выполняющий аналогичные задачи (более распространенные, чем вы думаете). Но вы все равно можете работать над своим проектом и улучшать его.

Если что-то подобное действительно существует, может ли ваш проект улучшить его?

Если аналог уже есть, вы можете сделать его более модульным или более эффективным. Вы можете попробовать реализовать его на другом языке или улучшить другими способами. Отличный способ — взглянуть на проблемы в этом репозитории. Попробуйте провести исследование с помощью существующих решений (если они есть) и выясните, какой элемент проекта можно улучшить. В моем случае я черпал вдохновение из прочитанной интересной исследовательской статьи (Fastformer: Additive Attention Can Be All You Need). Я также обнаружил официальную реализацию кода и реализацию документа сообществом в PyTorch. В конце концов, мой репозиторий, хотя и являлся производным от исследовательских работ, сильно отличался от существующих реализаций кода.

Вы можете объяснить свой проект, как будто мне 5 лет?

Объяснить суть своего проекта так, как будто вашему собеседнику пять лет, — отличное упражнение, которое я люблю выполнять, как только у меня появляется идея для репозитория. Я пытаюсь рассказать, какую цель стремится достичь проект, как он работает или почему он лучше аналогичных репозиториев, своему другу, который не очень разбирается в предмете. Это помогает мне развиваться или получить четкое представление о том, чем я хочу заниматься в своих проектах. Попытки объяснить проект другу часто также помогают мне обнаружить недостатки в моем плане или предположениях, которые я мог сделать, размышляя о проекте. Этот процесс помогает мне также тогда, когда я начинаю фазу разработки проекта на доске. Для этого можно использовать GitHub или Trello, JetBrains Spaces и так далее. Мне нравится использовать на этом этапе контрольные списки проектов и проблем GitHub, чтобы помочь мне управлять, расставлять приоритеты и иметь четкое общее представление о том, что нужно делать.

Что вы можете узнать из лучших репозиториев в аналогичных категориях?

Вы часто можете черпать вдохновение и учиться у репозиториев, принадлежащих к аналогичным категориям. Посмотрите, как написан и структурирован их код. В моем случае мне очень понравилось, как был написан reformer-pytorch. Его легко использовать в ваших проектах в качестве библиотеки Python.

Как разработать репозиторий вашего проекта

• Вы должны добавить лицензию с открытым исходным кодом. Она позволяет людям использовать, копировать, изменять и вносить свой вклад в ваш проект, сохраняя при этом авторские права. Вы можете легко найти лицензию, подходящую для вашего проекта, на Choosealicense.com.
• Напишите хороший README: об этом будет целый раздел, потому что он очень важен.
• Используйте согласованные соглашения о коде и четкие имена функций / методов / переменных. Часто можно использовать какой-нибудь инструмент статического анализа кода, например black, ktlint и другие.
• Убедитесь, что ваш код четко прокомментирован, задокументируйте свои мысли и обозначьте возможные проблемы.
• Убедитесь, что в истории изменений, проблемах или pull requests нет конфиденциальных материалов (например, ключей API, паролей или другой закрытой информации).
• Если вы разрабатываете приложение / библиотеку, я бы порекомендовал вам использовать GitHub releases. Старайтесь вести четкие примечания к выпуску и журналы изменений каждый раз, когда вы делаете новый релиз, чтобы сообщество могло отслеживать, что в нем нового. Запишите, какие ошибки были исправлены, и так далее.
• Наконец, вы также должны включить в репозиторий руководящие принципы, которые сообщают вашей аудитории, как участвовать в вашем проекте. Вы можете включить информацию о типах вкладов, которые вы ожидаете, или о том, как предложить запрос функции или отчет об ошибке и так далее.

Как написать хороший README

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

Объясните, что делает проект

Постарайтесь описать проект всего в 3-4 строчки. Не беспокойтесь о включении слишком большого количества мелких деталей или функций — вы можете добавить их в следующих разделах. Это первое, что читают посетители вашего репозитория, поэтому постарайтесь сделать его интересным.

Создайте отличное изображение обложки или логотипа проекта

Если у вас есть логотип или обложка для вашего проекта, укажите его.

Разместите графические ярлыки с метаданными

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

Добавьте визуальные эффекты

Вы всегда должны стараться включать визуальные элементы в свой README. Это может быть гифка, показывающая ваш проект в действии, или скриншот вашего проекта. Хорошая графика в README действительно может помочь убедить других разработчиков использовать ваш проект.

Объясните, как установить или настроить свой проект

Вы также должны включить конкретные инструкции по установке. Включите все необходимые зависимости и все остальное, что нужно установить другим разработчикам, чтобы использовать ваш проект. Если вы столкнулись с какими-либо проблемами при настройке проекта или установке зависимости, вполне вероятно, что пользователи тоже столкнутся с этим, поэтому убедитесь, что вы рассказали об этом. Это может быть очень просто:

Приведите четкие примеры использования

Я думаю, что это очень важно иметь в README. Не стоит ожидать, что другие разработчики будут долго читать ваш код — сделайте все как можно проще для них. Всегда проверяйте и перепроверяйте, что ваши примеры кода или раздел “How To” легко воспроизводимы. Кроме того, убедитесь, что он понятен широкому кругу пользователей, и не забудьте добавить инструкции по его запуску. Поскольку мой проект представляет собой пакет Python, я создал прилагаемый блокнот Colab Notebook, чтобы продемонстрировать использование этого пакета. Это позволяет людям легко опробовать его в своих браузерах, не устанавливая ничего на свои собственные машины. Есть довольно много продуктов, которые позволяют это делать, например, repl.it, Glitch, Codepen и так далее.

Объясните, где можно применить этот проект

Часто бывает полезно перечислить особенности вашего проекта и проблемы, которые он может решить. Вам не нужно описывать все функции, над которыми вы работали, но поделитесь основными из них. Это поможет разработчикам понять, на что способен ваш проект и почему им следует его использовать.

Расскажите, как люди могут получить помощь или внести свой вклад в проект

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

Внешняя документация

Предположим, вы думаете, что ваш README слишком длинный. В этом случае вы можете создать дополнительный веб-сайт документации и сделать ссылку на него в README, не пропуская какую-либо важную информацию. Поскольку я много работаю с Python, я обычно использую Sphinx для создания документации из строк документации Python. Я считаю Sphinx достаточно гибким и простым в настройке. Существует довольно много вариантов создания документации: mkdocs, Docsaurus, docsify и другие. Однако для моего проекта, который начал набирать обороты, мне не понадобился внешний веб-сайт с документацией. Вот пример того, что, как мне кажется, могло бы стать хорошим началом README из одного из моих собственных проектов. Это не полный README, а то, что поместилось на одной картинке: Наконец, для большего вдохновения я предлагаю вам попробовать использовать руководство “Make a README”.

Как привлечь посетителей на вашу страницу GitHub

После того, как вы создали красивый README и сделали проект общедоступным, вам нужно подумать о привлечении людей на страницу GitHub. Во-первых, убедитесь, что вы добавили соответствующие теги в репозиторий GitHub. Эти теги значительно упростят обнаружение проекта людьми, изучающими GitHub.

Поделитесь своим проектом в Hacker News, Twitter и Reddit

Отличные места для публикации о вашем проекте — Hacker News и Reddit. Но имейте в виду, что добиться того, чтобы ваш пост стал главной новостью или топ-постом на любой из этих платформ, — сложная задача. Когда один из моих репозиториев стал топ-историей, он получил более сотни звезд за пару часов. Но когда я изначально разместил свое репо на Hacker News, у меня не было ни одного голоса за. Только когда кто-то из сообщества заметил мой проект и опубликовал его в Hacker News, он стал главной новостью. Поэтому часто требуется хорошее планирование и небольшая помощь со стороны друзей, чтобы вывести ваш проект на вершину. В моем случае Twitter был действительно отличным местом, чтобы привлечь самых первых посетителей моего проекта и выйти на внешнюю аудиторию. Это часто служит отличным способом, позволяющим людям быстро понять, могут ли они заинтересоваться вашим проектом. И у вас просто есть ограниченное количество персонажей, чтобы продавать свой репозиторий людям. Кроме того, не переусердствуйте с публикациями о своем проекте на любой платформе, потому что он может быть отмечен как спам.

Отклики имеют значение, но не так, как вы думаете

Я часто получаю электронные письма или сообщения с откликами на свой проект или книгу. Но я твердо уверен, что в этом нет большого смысла. Если вы хотите, чтобы кто-то оставил отклик о вашем проекте, то сначала добейтесь, чтобы они использовали ваш проект и сочли его полезным. Также добавьте кнопку “tweet this project” в README. Тогда люди, которым нравится проект, естественно, начнут его распространять среди своей аудитории. Также имейте в виду, что отклики не приносят вам звезд. Люди будут отмечать ваш проект звездой только в том случае, если он им понравится. Это, безусловно, не означает, что вы не должны просить людей о помощи, обратной связи или проверке кода. В самом деле, вы всегда должны стараться реагировать на все виды отзывов: улучшения, ошибки, несоответствия и так далее. Всегда будьте готовы принять отрицательные отзывы и подумать о том, как вы можете улучшить их. Возможно, вы узнаете несколько новых вещей 🙂 В моем случае я заметил необычно большое количество посетителей, приходящих на проект из Twitter. Мой проект был реализован с помощью TensorFlow и Keras, и через пару дней я обнаружил, что сам создатель Keras обсуждает мой проект! Скорее всего, это произошло из-за того, что я добавил “Твитнуть об этом проекте” в верхней части README и позволил его распространить в соцсетях.

Советы сообщества разработчиков по созданию проекта на GitHub

• (Вы должны добавить) 1. Документацию 2. Журналы решений
• Хорошие шаблоны выпуска и PR. Вы также можете использовать формы выпуска GitHub.
• Документация (должна быть полной и) включать архитектуру приложения, упаковку, руководство по стилю, обсуждение кода, ссылки на используемую библиотеку технологической платформы, необходимые токены и так далее.

Заключение

Спасибо, что прочитали до конца. Я надеюсь, что это поможет вам в создании своих собственных проектов с открытым исходным кодом. Используя эти советы и экспериментируя, а также приложив усилия, вы можете создать отличный проект.