You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »


Эта инструкция для тех, кто получил нужные доступы, подготовил окружение для работы, склонировал репозиторий и готов начать работать! 

В этой статье мы откроем код с помощью visual studio, запустим локально у себя все сервисы, настроим линтер (автокоррекцию кодстайла), автодополнения и все нужные расширения.


Требования:

  1. Аккаунт на gitlab.com и доступ к репозиторию https://gitlab.com/fpmi/stfpmi-master (если ссылка открывается и не ведёт на 404 - то доступ есть. Иначе - обращайся к Ivan Arkhipov )
  2. Установленный и готовый к работе Docker
  3. Установленная и готовая к работе VSCode
  4. Склонированные исходники 

Шаг 1: Открываем исходники с помощью VSCode


Т.к. мой пользователь называется endevir, то у меня папка находится на пути /home/endevir/stfpmi-master

Выбери "Trust the authors"


Шаг 2: Запускаем docker-compose

Открой консольку vscode с помощью ctrl+` (это кнопка ё) и выполни команду

docker-compose up


Эта команда скачивает, собирает и запускает все сервисы на базе текущего исходного кода. На первых запусках может понадобиться до 20-30 минут, чтобы всё скачать, так что можешь сходить выпить чаю и почитать книжку (wink)

Команда docker-compose up блокирует терминал, поэтому хорошей идеей будет открыть ещё одно окно терминала в VSCode

Проверить статус контейнеров можно с помощью команды:

docker-compose ps

definition of done: Когда всё соберётся и запустится, сайт будет доступен по ссылке http://localhost:3000

Шаг 3: Устанавливаем python-зависимости для сервиса backend

Чтобы работало автодополнение и переход к исходникам библиотек (очень полезная штуковина крч), VSCode требуется наличие установленных python-пакетов.

Для javascript это работает из коробки благодаря папке node_modules, которая автоматически устанавливается в процессе сборки фронтенда.


Установи, если нужно, python:

sudo apt-get update && sudo apt-get install python3

Перейди в папку backend и установи все нужные зависимости (они указаны в файле requirements.txt):

cd backend
pip3 install -r requirements.txt


Шаг 4: Устанавливаем полезные расширения для VSCode:

Эти расширения превратят VSCode из красивого текстового редактора в мощную IDE и автодополнением и проверкой кодстайла.

Нам нужны расширения GitLens от GitKraken, набор расширений React Extension Pack и расширение Python от Microsoft


Шаг 5: Проверяем, что всё работает:

1) (Backend) Открой какой-нибудь .py файл в папке django_apps_<что-нибудь>. Он должен успешно проиндексироваться и покраситься зелёным. Попробуй, зажав ctrl и нажимая на библиотеку, перейти к её исходнику.

 

2) (Frontend) Попробуй аналогичные действия провернуть в любом javascript-файле


Поздравляю! Теперь у тебя всё готово к тому, чтобы начать кодить!

Не забудь прочитать мини-гайд по контрибьютигу: https://gitlab.com/fpmi/stfpmi-master/-/blob/dev/CONTRIBUTING.md



  • No labels